Document "required" clock parameter

[cookieguru]

Description

#433 introduced an annoying E_USER_DEPRECATED error in 3.2.0. This new paramater:

• Is not documented
• Was not announced in the release notes
• Is optional, but is noisy when omitted

I'll take responsibility for:

• My library that consumes web-token/jwt-framework requires ^3.1 but should be ~3.1
• Slim 4's default error handler appends deprecation notices to the existing payload. So a successful API response that should return this:

{"foo": "bar"}

is actually returning this:

{"foo": "bar"}{
  "statusCode": 500,
  "error": {
    "type": "SERVER_ERROR",
    "description": "ERROR: Since web-token\/jwt-checker 3.2.0: The parameter \"$clock\" will become mandatory in 4.0.0. Please set a valid PSR Clock implementation instead of \"null\". on line 25 in file \/var\/www\/vendor\/symfony\/deprecation-contracts\/function.php."
  }
}

on every request.

This issue is to request documentation for the parameter, and/or provide an Upgrading guide in the repo

I'll save the debate on whether "you used to do 'nothing', but in the future you must do 'something'" qualifies as a deprecation for a future ticket.

[cookieguru]

I'd also like to note that the error message doesn't provide the developer any information as to where the $clock parameter needs to be passed in. In addition, the stack trace does not mention any file from this library.

[Spomky]

Hi @cookieguru,

I'm sorry for the inconvenience. The release note is automatically created when the milestone is closed.
Unfortunately it is completely empty for this release and I don't know the reasons as all changes are properly labeled.

Documentation for the latest minor releases is missing. I will take care of it and align the documentation with the last modification.
I don't know how the Slim framework handles deprecation notices, but it can certainly be sent in some other way than adding it to the response body.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[cookieguru]

Thanks for the reminder StaleBot; this is still an issue

[Spomky]

The documentation is now up to date and a note is present for time-based parameter checkers.
Unfortunately, the release note cannot be changed.
I close the issue as I do not see any action for now, but feel free to reopen if deemed necessary.

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.