Remove set current app when allow global false #8462

marcospereira · 2018-06-07T15:49:15Z

Purpose

The current app was still being initialized even with the global state disabled. This removes that and adds some more warnings to instruct users to move away from Play.current and similars.

Background Context

See discussion in our Gitter channel: https://gitter.im/playframework/contributors?at=5b106c1d52e35117cdf94838

References

This can be considered a follow up of #8183.

There is no `@deprecated` tag in scaladocs since we have the `@deprecated` annotation.

marcospereira · 2018-06-07T15:51:17Z

framework/src/play/src/main/scala/play/api/Play.scala


    // Set the current app if the global application is enabled
    // Also set it if the current app is null, in order to display more useful errors if we try to use the app
-    if (globalApp || _currentApp == null) {


Here is the main purpose of the PR.

This will then have an impact on privateMaybeApplication that now returns a Try[Application] since it can fail.

We also have the check above globalApp && _currentApp != null && _currentApp.globalApplicationEnabled to decide whether to stop the current app. I think that can be globalApp && _currentApp != null, since the current app will only be set if the global app is enabled.

marcospereira · 2018-06-07T15:51:58Z

framework/src/play/src/main/scala/play/api/Play.scala

+
+  private[play] def privateMaybeApplication: Try[Application] = {
+    if (_currentApp != null) {
+      logger.warn(


Is warn level too noise?

@richdougherty @gmethvin @schmitch what do you think?

If we can make sure this only prints once when the app starts up it's fine, but it'd be pretty annoying to have this on every access (which could be every request). I think the deprecation is good enough. We're already making users opt in to having the global app.

well we could create a dummy variable and initialize it here:

private lazy val nonEmptyCurrentApp = { logger.warn(...) true } private[play] def privateMaybeApplication: Try[Application] = { Option(_currentApp) match { if (_currentApp != null) { val _ = nonEmptyCurrentApp }

guess this would memoize the logging and only print the warning once.

I think the simplest solution is to move the log to where we set the current app (in Play.start).

marcospereira · 2018-06-07T15:52:58Z

framework/src/play/src/main/scala/play/api/http/HttpErrorHandler.scala

 /**
 * A lazy HTTP error handler, that looks up the error handler from the current application
 */
+@deprecated("Access the global state. Inject a HttpErrorHandler instead", "2.7.0")


It was not deprecated before, but it should.

marcospereira · 2018-06-07T15:53:45Z

framework/src/play/src/main/scala/play/api/libs/Crypto.scala

+import scala.util.{ Failure, Success }
+
 // Keep Crypto around to manage global state for now...
+@deprecated("Access global state. Inject a CookieSigner instead", "2.7.0")


This is a private API, but adding deprecated here to help us to find it later.

ignasi35

LGTM (with small comment wrt logs/exceptionMessage)

ignasi35 · 2018-06-07T19:24:15Z

framework/src/play/src/main/scala/play/api/Play.scala

+          |You are accessing the application using deprecated methods that exists only to access
+          |global state. If you need an instance of Application, use Dependency Injection.
+        """.stripMargin)
+      Success(_currentApp)


Will this be a multiline trace?

Yes.

But of course, users can silence this via Logback configuration. It shouldn't happen a lot though since it is quite unusual to access the current application for each request. Do you think it would be better to have a single line here?

@ignasi35 I'm moving this to Play.start to ensure the log will happen only once.

gmethvin · 2018-06-09T04:17:47Z

framework/src/play/src/main/scala/play/api/Play.scala

+
+  private[play] def privateMaybeApplication: Try[Application] = {
+    if (_currentApp != null) {
+      logger.warn(


If we can make sure this only prints once when the app starts up it's fine, but it'd be pretty annoying to have this on every access (which could be every request). I think the deprecation is good enough. We're already making users opt in to having the global app.

gmethvin · 2018-06-09T04:21:19Z

framework/src/play/src/main/scala/play/api/Play.scala

+           |The global application is disabled. Set $GlobalAppConfigKey to allow global state here.
+           |If $GlobalAppConfigKey is already configured to allow global state, then you need to start
+           |the application too.
+       """.stripMargin


This message would be a good place to recommend using dependency injection and warn that Play.current will be removed in the future, something like:

The global application reference is disabled. Play's global state is deprecated and will be removed in a future release. You should use dependency injection instead. To enable the global application anyway, set $GlobalAppConfigKey = true

gmethvin · 2018-06-09T04:28:09Z

framework/src/play/src/main/scala/play/api/Play.scala


    // Set the current app if the global application is enabled
    // Also set it if the current app is null, in order to display more useful errors if we try to use the app
-    if (globalApp || _currentApp == null) {


We also have the check above globalApp && _currentApp != null && _currentApp.globalApplicationEnabled to decide whether to stop the current app. I think that can be globalApp && _currentApp != null, since the current app will only be set if the global app is enabled.

marcospereira · 2018-06-12T17:59:48Z

@gmethvin and @ignasi35 please review again. :-)

* remove apache commons libs (playframework#8455) * remove apache commons libs currently play added a lot of "helper" libraries in the past, however with recent JVM upgrades and more and more stuff inside the JVM itself these got more and more unnecessary. Actually this imports some Classes from apache commons lang3, however only a really small subset of the library is imported. The subset itself barly changed over the recent years and Play mostly used just the reflect stuff of commons lang3 * Remove set current app when allow global false (playframework#8462) * Remove imports to current app * Add missing deprecation notes * Remove invalid scaladoc tags There is no `@deprecated` tag in scaladocs since we have the `@deprecated` annotation. * Do not set current app when global state is disabled * Configure mima filter * Clear warn messages when using global state * Just stop the current app if global state is enabled * logback graceful shutdown (playframework#8407) * add shutdown hook to logback-play-default.xml playframework#8277 * update SettingsLogger.md documentation playframework#8277 * delete an unnecessary line playframework#8277. * add shutdown hook to logback-play-logSql.xml playframework#8277 * add line playframework#8277 * update SettingsLogger.md playframework#8277 * update SettingsLogger.md playframework#8277

* Update Play, interplay and other dependencies * Remove access to global state and deprecated APIs The main change is to remove any access to `Play.maybeApplication` which Play does not set by default anymore. See playframework/playframework#8462. This implies changing tests that also access the global state when using the `Action` object. So now all the tests are instead using `appRoutes` instead of `routes` since the later does not provides a way to access an ActionBuilder. Finally, some minor deprecated calls were replaced with the new APIs. * Travis configuration tweaks Avoid generating too much log when running the tests. It was also necessary to use `sudo: required` to workaround a Travis problem when using Google Chrome: See travis-ci/travis-ci#8836 Moreover, Scala versions were updated. * Deprecate PhantomJS support Selenium had deprecated PhantomJS support since it is no longer actively developed. Support will be dropped in Selenium so we should deprecated it here too. * Enable users to better customize FirefoxDriver creation It was possible to customize the FirefoxProfile, but not FirefoxOptions. Now both are available across all the APIs. * Enable users to better customize ChromeDriver creation * Remove ehcache dependencies * Remove code duplication

marcospereira added 4 commits June 6, 2018 18:42

Remove imports to current app

50e0d17

Add missing deprecation notes

e2efc6b

Remove invalid scaladoc tags

b005dcc

There is no `@deprecated` tag in scaladocs since we have the `@deprecated` annotation.

Do not set current app when global state is disabled

494d598

marcospereira requested a review from ignasi35 June 7, 2018 15:54

marcospereira commented Jun 7, 2018

View reviewed changes

ignasi35 approved these changes Jun 7, 2018

View reviewed changes

ignasi35 mentioned this pull request Jun 7, 2018

Manage lifecycle with Akka's Coordinated Shutdown #8406

Merged

3 tasks

Configure mima filter

837eb04

gmethvin reviewed Jun 9, 2018

View reviewed changes

marcospereira added 2 commits June 12, 2018 13:58

Clear warn messages when using global state

f1725d0

Just stop the current app if global state is enabled

9a9d39a

gmethvin approved these changes Jun 12, 2018

View reviewed changes

marcospereira merged commit a39b208 into playframework:master Jun 12, 2018

marcospereira deleted the remove-set-current-app-when-allow-global-false branch June 12, 2018 19:28

marcospereira mentioned this pull request Jun 19, 2018

No need for this check condition #8405

Closed

8 tasks

TimMoore added this to the Play 2.7.0 milestone Dec 10, 2018

jtjeferreira mentioned this pull request Jul 22, 2019

Play.privateMaybeApplication should return Failure instead of sys.error #9490

Merged

8 tasks

Uh oh!

Remove set current app when allow global false #8462

Remove set current app when allow global false #8462

Uh oh!

Conversation

marcospereira commented Jun 7, 2018

Purpose

Background Context

References

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

schmitch Jun 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ignasi35 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marcospereira commented Jun 12, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

schmitch Jun 10, 2018 •

edited

Loading