Add features and organize code to be more customizable

[zhshize]

I think that Customizable is the most important property when I am applying this library to many old projects. So I do many modifications, it will be fantastic!

I merged new updates during development, don't worry about the inconsistency between two repos.

The doc is added in README.md, it is helpful.

I think that the API changes are so significant that it could be a major version release.

What's inside

Fixes:

• Typos

Enhancements:

• Type declarations
• Documentation & PHPDocs
• Add PHP version requirement
• Move the interfaces to Contacts namespace (shows that these interfaces are good to implement and replace)
• Move exception classes to Exceptions namespace
• Add events, all OIDC and authentication related events will be dispatched
• Add Contracts\OIDCAuthenticatable to mark user object with access token features
• Split OIDCAuthServiceProvider into many tiny functions for customization (extends and small overwritings)
• Split CallbackController into many tiny functions for customization (extends and small overwritings)

Features:

• Refreshing access token (a function for refresh manually and an option for refresh automatically)
• Add Facade OIDC

Modifications:

• New OIDCSessionGaurd (doesn't extend Laravel SessionGuard for being concise)
• All codes about authorization code flow are moved into the class AuthorizationCodeFlow
• All codes about storing token are moved into the class TokenStore

Significant Updates

• config/oidc-auth.php renamed to config/oidc_auth.php
  Because of Laravel naming convention
• UserFactoryInterface moved to Contracts\OIDCAuthenticatableFactory
• Middleware Authenticate moved to Middleware\Authenticate
• SessionGuard replaced by OIDCSessionGaurd
• SessionUserProvider renamed to OIDCSessionUserProvider

• InvalidStateException, AuthenticationException, AuthenticationErrorException moved to Exceptions namespace

  Give me some comment, I will be glad to improve the code.

[xdavidwu]

I think that the API changes are so significant that it could be a major version release.

Per SemVer, we won't bump major unless we feel easy to gurantee API stability.

config/oidc-auth.php renamed to config/oidc_auth.php Because of Laravel naming convention

Is that a thing in config/ naming? A quick find in my work environment over vendor/ of a few laravel projects shows a case with - (ide-helper.php in barryvdh/laravel-ide-helper, I believe this is popular), and nothing with a _.

This is a huge patchset and require time to review. You should probably split the changes into individual PRs next time.

[zhshize]

To Do:

• List breaking changes
• Fold CallbackController, TokenStore, OIDCAuthServiceProvider
• Remove OIDC Facade
• Other issues in above conversations
• Rearrange commit history
• Rebase from main

[zhshize]

Breaking changes

Renamed & moved files

• config/oidc-auth.php renamed to config/oidc_auth.php
• Exceptions was moved from top level namespace LaravelOIDCAuth to LaravelOIDCAuth\Exceptions:
  • AuthenticationErrorException
  • AuthenticationException
  • InvalidStateException
• Middleware LaravelOIDCAuth\Authenticate moved to LaravelOIDCAuth\Middleware\Authenticate

  Removed files

• Class OIDCProviderService was removed
• Class SessionUserProvider was removed

  UserFactory

  The UserFactory must implement LaravelOIDCAuth\Contracts\OIDCAuthenticatableFactory. UserFactoryInterface was removed.

[xdavidwu]

about addition of composer.lock: I think we don't actually need to use lock file in library development. It will not be respected when used as a library anyway. I am against tracking a lock file as it may hinder potential chances on catching problems on development.

[xdavidwu]

config/oidc-auth.php renamed to config/oidc_auth.php

I'm still against this until this convention is documented in official documents, or there is widespread adoption.

LaravelOIDCAuth\OIDCAuthenticatableFactory

afaict it's LaravelOIDCAuth\Contracts\OIDCAuthenticatableFactory

[zhshize]

config/oidc-auth.php renamed to config/oidc_auth.php

I'm still against this until this convention is documented in official documents, or there is widespread adoption.

There is an example: https://github.com/laravel/cashier-mollie/tree/develop/config and a non-official guide: https://github.com/alexeymezenin/laravel-best-practices#follow-laravel-naming-conventions

I like config('oidc_auth.auto_refresh') better than config('oidc-auth.auto_refresh').

LaravelOIDCAuth\OIDCAuthenticatableFactory

afaict it's LaravelOIDCAuth\Contracts\OIDCAuthenticatableFactory

LaravelOIDCAuth\OIDCAuthenticatableFactory -> LaravelOIDCAuth\Contracts\OIDCAuthenticatableFactory updated.

[zhshize]

about addition of composer.lock: I think we don't actually need to use lock file in library development. It will not be respected when used as a library anyway. I am against tracking a lock file as it may hinder potential chances on catching problems on development.

I'll remove that commit.

[xdavidwu]

There is an example: https://github.com/laravel/cashier-mollie/tree/develop/config

While that is not a famous package, it seems like that is the only example with multiple words under laravel namespace (although it is moving out). If we are going for underscores, we should also rename the route definition file.

[xdavidwu]

Mark resolved threads as resolved (thread status, not by commenting) and I will do another review round.

[xdavidwu]

this needs a rebase

[xdavidwu]

Closing due to inactivity and lack of consensus.

To whom it may concern, discuss with maintainers before implementing such a big patchset.