Review main Merged Breaking

41633[!!!][TASK] Append hash to default log file name

Alexander Stehlik CR +2 V +2 Normal +73 −14 updated 07/25/15, 10:54

Commit message

A hash is appended to the default log file name the FileWriter uses
when no other log file is provided in the configuration.

To make this work the logFile configuration is removed for the
writerConfiguration section.

Additionally the "deprecated" log configuration section is removed
because it is currently not used by the core.

Review

  • Code review CR +2
    • Markus Klein +2
    • Steffen Müller +1
    • Anja Leichsenring +1
  • Verified V +2
    • Markus Klein +2
    • Steffen Müller +1
    • Anja Leichsenring +1

Issues 1

Files 3

Review log 21

  1. Alexander Stehlik uploaded patch set 1 07/17/15, 22:03

  2. Xavier Perseguers voted on patch set 1 CR +1 V +1 07/17/15, 23:03

  3. Christian Kuhn voted on patch set 1 CR -1 07/18/15, 00:17

  4. Markus Sommer commented on patch set 1 CR -1 07/18/15, 10:26

    Please Update your commit message and add "Release"
  5. Xavier Perseguers updated the commit message in patch set 2 07/18/15, 11:19

  6. Christian Kuhn commented on patch set 2 CR -2 07/18/15, 11:33

    blocked for now ... needs a discussion again on how to solve it.
  7. Georg Ringer commented on patch set 2 07/18/15, 19:07

    my opinion: make an IMPORTANT rst and add it to the DefaultConfiguration as well
  8. Alexander Stehlik commented on patch set 2 07/19/15, 07:04

    The upside of using it in the DefaultConfiguration would be that we do not need to care about handling the ::class stuff when writing configuration. The downside would be that there is a function called every time the configuration is included to generate the hash (in FactoryConfiguration just the final string would be written and the method would only be called once the configuration is build for the first time). My proposal would be a silent upgrade when no overwritten configuration is present in combination with a IMPORTANT rst.
  9. Christian Kuhn commented on patch set 2 CR -1 07/21/15, 11:38

    My proposal: * Remove the "deprecation" configuration altogether (breaking.rst): This seems to be totally unused and collides with the filename configuration in GeneralUtility which everybody uses. * Keep the default file writer configuration, but remove the fileName configuration, the system will then fall back to $defaultLogFile from FileWriter. * Adapt the $defaultLogFile handling in FileWriter to do the hashing in case it is fired. This way, we have no additional configuration options in LocalConfiguration for each and every instance, have a sane default, need no silent upgrade and remove an unused configuration option. Opinions?
  10. Alexander Stehlik uploaded patch set 3 07/23/15, 22:37

  11. Alexander Stehlik commented on patch set 3 07/23/15, 22:39

    Patch adjusted according to Christian's suggestions.
  12. Georg Ringer voted on patch set 3 CR +1 V +1 07/24/15, 06:51

  13. Steffen Müller uploaded patch set 4 07/24/15, 13:39

  14. Steffen Müller voted on patch set 4 CR +1 V +1 07/24/15, 13:43

  15. Steffen Müller commented on patch set 4 07/24/15, 13:44

    Thanks for that one. I changed the rst doc by recommending AdditionalConfiguration.php for custom log config instead of LocalConfiguration.php
  16. Anja Leichsenring voted on patch set 4 CR +1 V +1 07/24/15, 15:52

  17. Markus Klein voted on patch set 4 CR +2 V +2 07/24/15, 16:00

  18. Markus Klein merged patch set 4 07/24/15, 16:01

  19. Helmut Hummel commented on patch set 5 07/24/15, 16:13

    post -1 this should be fixed in a followup!

    FileWriter.php:227

    Please use GeneralUtility::hmac() for creating such hashes!
  20. Christian Kuhn commented on patch set 5 07/24/15, 16:19

    Breaking-52705-DefaultLogConfigurationIsChanged.rst:57

    actually, this should NOT mention AdditionalConfiguration ... the core does not support this file at all, and configuration stuff should go to LocalConfiguration. AdditionalConfiguration is rather a hack from core point of view, and the core should never recommend doing anything there. It will only get harder to drop this hack later.
  21. Markus Klein commented on patch set 5 07/25/15, 10:54

    Breaking-52705-DefaultLogConfigurationIsChanged.rst:57 Reply

    Well, LocalConfiguration must not be touched manually. That's what we spread the word about. I therefore suggest to simply use your ext_localconf of your site setup extension