get_it

• allReady() now caches its Future and returns the same instance on repeated calls
• Cache is invalidated when new async singletons are registered
• Pending async singletons complete their ready completer when removed via unregister() or scope reset

Remove generated test folder from example

• Remove gradlew patterns from .gitignore and example/.gitignore to include scripts
• Add gradle-wrapper.jar to .pubignore to exclude binary from package
• Keeps gradle scripts for building example, excludes ~60KB binary
• Fixes pub publish warning about ignored files

Update workflow to trigger on main branch

Update workflow to trigger on main branch

Update workflow to trigger on main branch

Update workflow to trigger on main branch

Update workflow to trigger on main branch

Update workflow to trigger on main branch

• Reduce from 704 to 192 lines following README_TEMPLATE.md
• Add prominent docs link to flutter-it.dev
• Emphasize construction set philosophy
• Remove Flutter Community banner (preparing for own logo)
• Update blog post URLs to new blog.burkharts.net domain
• Add startup orchestration article link
• Streamline Quick Start with simple 3-step example
• Link detailed content to documentation site
• Update footer with flutter_it slogan

Thanks to PR by @Hu-Wentao we now expose part of the internal state of get_it so tool authors have more options. While doing so internal renaming has happened, so where previously where the term "ServiceFactory" was uses we not use consistently ObjectRegistration and instead of variables with factory in the name we use registration this has not impact on the public API so it is not a breaking change.

• adding documentation https://github.com/flutter-it/get_it/issues/411
• registerCachedFactoryAsync usded FactoryFunc instead of FactoryFuncAsync https://github.com/flutter-it/get_it/issues/410
• adding getMaybe which will return null instead of throwing an exception in case a type is not registered
• dependsOn of registerSingletonWithDependencies is now required. Although this could be seen as a breaking change, if you didn't pass dependsOn your code wouldn't have worked before so I won't define this as breaking change

• fixing linter warning thanks to @PatrickChrestin

• Fixes by @kuhnroyal and @ArtAhmetajCR who spotted some flaws in my latest changes. Thanks a lot

• Bugfixes and improvements for certain edge cases thanks to @KnightOfBlackLily and @kuhnroyal

• official new release with all the changes

• adding cachedFatories and better scope protection against race conditions

• testing weak references in lazySingeltons

• adding changeTypeInstanceName

• fixing bug in unregister that happened if you tried to unregister a named registration by providing an instance instead of the type and the instance name

• releaseInstance will now throw if the instance isn't registered

• fixing negative reference count

• getAll() and getAllAsync() now have a fromAllScopes parameter.
• adding safeguards according to https://github.com/fluttercommunity/get_it/issues/364 to make it impossible to call push/popScope while the init() function of another pushScope is running.
• fixed an unsafe type check when using a runtime type to access an object in get_it.

• thanks to the PR by @kasefuchs https://github.com/fluttercommunity/get_it/pull/361 getAll is now available in an async version too.

• fig for bug that was introduced in 7.6.8 https://github.com/fluttercommunity/get_it/issues/358

• merged PR by @venkata-reddy-dev https://github.com/fluttercommunity/get_it/pull/356 adding new skipDoubleRegistration flag for testing

• merged PR by @subzero911 https://github.com/fluttercommunity/get_it/pull/330

• Thanks to PR by @bvoq getIt.reset, getIt.popScope, getIt.dropScope now dispose registered objects in the reverse order in which they were registered.

• fixed the throwing of a StateError that was previously thrown as String

• push new version because pub didn't list this one

• fix linter error

• added isFinal scope parameter which fixes https://github.com/fluttercommunity/get_it/issues/326
• version bump of dependencies and updates readme

• merged PR by lacopiroty https://github.com/fluttercommunity/get_it/pull/297 which now allows to access objects inside GetIt by runtime type too like

    getIt.registerSingleton(TestClass());

    final instance1 = getIt.get(type: TestClass);

    expect(instance1 is TestClass, true);

• fix for https://github.com/fluttercommunity/get_it/issues/299
• fix for https://github.com/fluttercommunity/get_it/issues/300

• new function dropScope(scopeName) which allows to remove and dispose any named scope even if it's not the top one. Great PR by @olexale https://github.com/fluttercommunity/get_it/pull/292 which fixes sort of race conditions if you create scopes just for the life time of a widget.

• PR from @dzziwny which fixed an edge case with LazySingletons https://github.com/fluttercommunity/get_it/pull/284
• Changed an assertion in case that an object is not registered to an Exception that also will throw in real time so that you get meaningful errors based on https://github.com/fluttercommunity/get_it/issues/312

• registerSingleton now returns the passed instance as a return value thanks to the PR by @Rexios80 https://github.com/fluttercommunity/get_it/pull/242
• In some cases GetIt will print error messages to the debug output. Now this won't happen anymore in release mode and can be completely disabled by setting GetIt.noDebugOutput=true following the PR from @James1345

New features:

• popScopeTil got a new optional inclusive parameter so you can now decide if scope with the passed name should be popped too or only the ones above
• PR by @jtdLab that adds to reset a LazySingleton by providing an existing instance
• Fix for an internal state error by @ioantsaf
• Fix for a rare edge case if you manually signalReady
• Many PRs with improvements to spelling and grammar of readme, source documentation and even one assert message by @selcukguvel @isinghmitesh @UsamaKarim @nilsreichardt and Os-Prog @Ae-Mc

• fix for https://github.com/fluttercommunity/get_it/issues/210
• Parameters of factories are no longer needed to be casted because they are nullable
• downgraded the dependency on async to 2.6 again
• you couldn't push two Scopes without a name

• fixed bug with manual synchronization of SingletonsWithDependencies https://github.com/fluttercommunity/get_it/issues/196

• Fix for https://github.com/fluttercommunity/get_it/issues/186

• Thanks to the clever PR https://github.com/fluttercommunity/get_it/pull/185 by @kmartins unregister and resetLazySingleton now only have to be awaited if you use an async disposal function.

• pushNewScope() now got an optional init parameter where you can pass a function that registers new objects inside the newly pushed Scope. Doing the registration in this function ensures that the onScopeChanged call-back is called after the objects are registered.

• The new Disposable interface had a typo that now got corrected. You could call this a breaking change but as the last version change is just three days old I guess not many people will be affected by this correction.

Getting notified when a scope change happens

When using scopes with objects that shadow other objects its important to give the UI a chance to rebuild and acquire references to the now active objects. For this you can register an call-back function in GetIt The getit_mixin has a matching rebuiltOnScopeChange method.

  /// Optional call-back that will get call whenever a change in the current scope happens
  /// This can be very helpful to update the UI in such a case to make sure it uses
  /// the correct Objects after a scope change
  void Function(bool pushed)? onScopeChanged;

This is a breaking change because there were some inconsistencies in the handling of the disposal functions that you can pass when registering an Object, pop a Scope or use unregister() resetLazySingleton(). Some of accepted a FutureOr method type, others just a void which meant you couldn't use async functions consistently. With this release you can use async functions in all disposal functions which unfortunately also required to change the signatures of the following functions:

  Future<void> reset({bool dispose = true});

  Future<void> resetScope({bool dispose = true});

  Future<void> popScope();

  Future<bool> popScopesTill(String name);

  FutureOr resetLazySingleton<T extends Object>({
    Object? instance,
    String? instanceName,
    FutureOr Function(T)? disposingFunction,
  });

  FutureOr unregister<T extends Object>({
    Object? instance,
    String? instanceName,
    FutureOr Function(T)? disposingFunction,
  });

Basically all functions that can possibly call a disposal functions should be awaited.

Implementing the Disposable interface

Instead of passing a disposing function on registration or when pushing a Scope from V7.0 on your objects onDispose() method will be called if the object that you register implements the Disposable´interface:

abstract class Disposable {
  FutureOr onDispose();
}

Getting notified about the shadowing state of an object

In some cases it might be helpful to know if an Object gets shadowed by another one e.g. if it has some Stream subscriptions that it want to cancel before the shadowing object creates a new subscription. Also the other way round so that a shadowed Object gets notified when it's "active" again meaning when a shadowing object is removed.

For this a class had to implement the ShadowChangeHandlers interface:

abstract class ShadowChangeHandlers {
  void onGetShadowed(Object shadowing);
  void onLeaveShadow(Object shadowing);
}

When the Object is shadowed its onGetShadowed() method is called with the object that is shadowing it. When this object is removed from GetIt onLeaveShadow() will be called.

• Thanks to this PR https://github.com/fluttercommunity/get_it/pull/181 by @n3wtron you can now also make objects depend on other objects not only by type but also by type and name if you used a named registration

• small fix in getAsync with parameters

• Exceptions that occur during an async initialisation are now forwarded to the future that allReady() returns instead to get swallowed https://github.com/fluttercommunity/get_it/issues/148
• Added a property currentScopeName to query the name of the currently active scope https://github.com/fluttercommunity/get_it/issues/153
• popScope will know throw an Exception instead just an assert if you are already on the baseScope and you try to pop it.

• Official null safety release

• fixed https://github.com/fluttercommunity/get_it/issues/138 when calling unRegister the dispose function that can be passed when registering wasn't called.

• fixed formatting in readme

• New scope support for registration
• optional dispose functions for registered objects
• Breaking change: reset() now is async and returns a Future because it will call the new optional disposal functions that can be async
• Breaking change: If you use names to register your objects you now have to provide a type too or at least make sure the compiler can infer the type. With this change it is now possible to use the same name for different types.

• experimental