From ffb3ac74e5f8faf9b8ecd194d26e9957e970c421 Mon Sep 17 00:00:00 2001 From: Tatyana Koleva Date: Tue, 30 Apr 2024 15:02:50 +0300 Subject: [PATCH] Fix instructions and clean up changelogs --- CHANGELOG-v5.md | 94 ------------------------------------------------- CHANGELOG-v6.md | 74 -------------------------------------- README.md | 5 +-- 3 files changed, 3 insertions(+), 170 deletions(-) delete mode 100644 CHANGELOG-v5.md delete mode 100644 CHANGELOG-v6.md diff --git a/CHANGELOG-v5.md b/CHANGELOG-v5.md deleted file mode 100644 index b02f4ac5..00000000 --- a/CHANGELOG-v5.md +++ /dev/null @@ -1,94 +0,0 @@ -# Changelog -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - -## [5.2.1] - 2021-10-13 - -### Fixed -- Check if token is not expired [PR-20](https://github.com/OXID-eSales/graphql-base-module/pull/20) - -## [5.2.0] 2021-05-17 - -no changes compared to RC2 - -## [5.2.0-rc2] 2021-05-11 - -### Fixed -- Validating JWT signature -- Minor typos in the docs - -## [5.2.0-rc1] 2021-04-30 - -### Changed -- Update module to use the new API from [lcobucci/jwt](https://lcobucci-jwt.readthedocs.io/en/latest/upgrading/#v3x-to-v4x) 4.0.0 -- Prevent accidental PHP session usage -- Move Schema documentation to https://oxid-esales.github.io/graphql-storefront-module -- Changed `OxidEsales\GraphQL\Base\Infrastructure\Legacy::createUniqueIdentifier` method to static. -- Token does not contain information for customer's groups as changes to the groups should take immediate effect. -- Update `thecodingmachine/graphqlite` from `^3.1.2` to `^4.1.2` and fixed compatibility issues - -### Added -- [`Server-Timing`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing) response header -- Allow `errors` in response with `data` -- Introduce anonymous token with claim to a randomly generated userid and group `oxidanonymous`. -- Event `BeforeTokenCreation` - using it you may change the builder object before token gets created. - -### Removed -- Removed CORS headers (https://docs.oxid-esales.com/interfaces/graphql/en/latest/troubleshooting.html) -- Interfaces - - `OxidEsales\GraphQL\Base\Framework\ErrorCodeProvider` - - `OxidEsales\GraphQL\Base\Exception\HttpErrorInterface` -- Methods - - `OxidEsales\GraphQL\Base\Exception\Exists::getHttpStatus` - - `OxidEsales\GraphQL\Base\Exception\InvalidLogin::getHttpStatus` - - `OxidEsales\GraphQL\Base\Exception\InvalidRequest::getHttpStatus` - - `OxidEsales\GraphQL\Base\Exception\InvalidToken::getHttpStatus` - - `OxidEsales\GraphQL\Base\Exception\NotFound::getHttpStatus` - - `OxidEsales\GraphQL\Base\Exception\OutOfBounds::getHttpStatus` - -## [5.1.1] - 2020-12-16 - -### Changed -- Updated documentation after catalogue, account and checkout module have been merged as - storefront graphql module -- deployment for GraphQL schema docs has been polished -- update `lcobucci/jwt` from `^3.3.1` to `^3.4.1` and fixed deprecation warnings - -## [5.1.0] - 2020-11-23 - -### Added -- documentation on placing an order via GraphQL - -### Deprecated -- `OxidEsales\GraphQL\Base\Service\Legacy` - -## [5.0.0] - 2020-10-29 - -### Added - -- Send `Access-Control-Allow-Origin: *` response header with every response -- Schema documentation available at https://oxid-esales.github.io/graphql-base-module -- New methods: - - `Service/Legacy::getEmail` - -### Changed - -- Module id changed from **oe/graphql-base** to **oe_graphql_base** for being compatible with shop documentation -- **BC-BREAK!** fix wording of `lowerThen` / `greaterThen` to `lessThan` / - `greaterThan` - OXDEV-3956, thanks [@Zockman](https://github.com/Zockman) -- Codeception acceptance tests configured and used for testing actual module workflow - -### Fixed - -- Preflight CORS handling -- Fixed module activation/deactivation event pointers - -[5.2.1]: https://github.com/OXID-eSales/graphql-base-module/compare/v5.2.0...v5.2.1 -[5.2.0]: https://github.com/OXID-eSales/graphql-base-module/compare/v5.2.0-rc2...v5.2.0 -[5.2.0-rc2]: https://github.com/OXID-eSales/graphql-base-module/compare/v5.2.0-rc1...v5.2.0-rc2 -[5.2.0-rc1]: https://github.com/OXID-eSales/graphql-base-module/compare/v5.1.1...v5.2.0-rc1 -[5.1.1]: https://github.com/OXID-eSales/graphql-base-module/compare/v5.1.0...v5.1.1 -[5.1.0]: https://github.com/OXID-eSales/graphql-base-module/compare/v5.0.0...v5.1.0 -[5.0.0]: https://github.com/OXID-eSales/graphql-base-module/compare/v4.0.0...v5.0.0 diff --git a/CHANGELOG-v6.md b/CHANGELOG-v6.md deleted file mode 100644 index d78f53f1..00000000 --- a/CHANGELOG-v6.md +++ /dev/null @@ -1,74 +0,0 @@ -# Changelog -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - -## [6.0.4] - Unreleased - -### Added -- Workflow trigger to update schema in documentation - -## [6.0.3] - 2022-08-08 - -### Fixed -- Improve the installation instructions [PR-26](https://github.com/OXID-eSales/graphql-base-module/pull/26) - -## [6.0.2] - 2022-03-31 - -### Changed -- Require version 4.2 of graphql-upload fork. - -## [6.0.1] - 2021-12-08 - -### Fixed -- Coding style / docblock fixed: - - [PR-21](https://github.com/OXID-eSales/graphql-base-module/pull/21) - -### Changed -- Update documentation for Storefront 2.0 -- Added translations for token lifetime setting. - -## [6.0.0] - 2021-11-03 - -### Added -- PHP 8 support -- `OxidEsales\GraphQL\Base\DataType\ShopModelAwareInterface` intended to be implemented by DataTypes related to a `OxidEsales\Eshop\Core\Model\BaseModel` -- Token service `OxidEsales\GraphQL\Base\Service\Token` for accessing current token -- User DataType `OxidEsales\GraphQL\Base\DataType\User` in place of former `OxidEsales\GraphQL\Base\Framework\UserData` and `OxidEsales\GraphQL\Base\Framework\AnonymousUserData` classes - - It holds an instance of `OxidEsales\Eshop\Application\Model\User` which it tries to actually load. For an anonymous user there will be no record in the database, so `OxidEsales\Eshop\Application\Model\User::isLoaded()` will be false in this case. - - Implements the `OxidEsales\GraphQL\Base\DataType\ShopModelAwareInterface` -- File upload handling - - Used the special fork of `Ecodev/graphql-upload`, which supports PHP8 and `webonyx/graphql-php ^0.13` to fit other components -- `OxidEsales\GraphQL\Base\Framework\Constraint\BelongsToShop` token validation constraint -- `OxidEsales\GraphQL\Base\Service\JwtConfigurationBuilder` to handle everything related to JWT token configuration. -- Token lifetime is configurable via module setting (default 8 hours) and checked during token validation. -- Added method `OxidEsales\GraphQL\Base\Service\ModuleConfiguration::getTokenLifeTime()` - -### Changed -- Updated to `thecodingmachine/graphqlite ^4.0` and `lcobucci/jwt ^4.0` -- `Lcobucci\JWT\Token` cannot be used directly anymore, changed to UnencryptedToken interface everywhere -- DataType directory contents has been restructured to: Filter, Pagination, Sorting -- Improved `OxidEsales\GraphQL\Base\Service\Authentication` - - `TheCodingMachine\GraphQLite\Security\AuthenticationServiceInterface` is now fully implemented - - Extracted token creation to `OxidEsales\GraphQL\Base\Service\Token` service - - Extracted token validation to `OxidEsales\GraphQL\Base\Service\TokenValidator` service - - Token validation is done once during token reading procedure now - - Checking if token user is in "blocked" group is done here as well -- Logic changes as `OxidEsales\GraphQL\Base\Framework\NullToken` has been removed. Token may be available or not, no stable default states anymore. -- Tests readability improved greatly -- `OxidEsales\GraphQL\Base\Framework\ModuleSetup` class moved to `OxidEsales\GraphQL\Base\Infrastructure\ModuleSetup` -- Renamed `OxidEsales\GraphQL\Base\Service\KeyRegistry` to `OxidEsales\GraphQL\Base\Service\ModuleConfiguration` - -### Removed -- PHP 7.3 support -- Removed framework classes - - `OxidEsales\GraphQL\Base\Framework\UserData` - - `OxidEsales\GraphQL\Base\Framework\AnonymousUserData` - - `OxidEsales\GraphQL\Base\Framework\NullToken` -- Removed deprecated `OxidEsales\GraphQL\Base\Service\Legacy` - -[6.0.3]: https://github.com/OXID-eSales/graphql-base-module/compare/v6.0.2...v6.0.3 -[6.0.2]: https://github.com/OXID-eSales/graphql-base-module/compare/v6.0.1...v6.0.2 -[6.0.1]: https://github.com/OXID-eSales/graphql-base-module/compare/v6.0.0...v6.0.1 -[6.0.0]: https://github.com/OXID-eSales/graphql-base-module/compare/v5.2.1...v6.0.0 diff --git a/README.md b/README.md index 6df95983..9dccf37e 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ This assumes you have OXID eShop (at least `OXID-eSales/oxideshop_ce: v7.0.0` co ## Branch Compatibility +* b-7.1.x branch is compatible with OXID eShop compilation b-7.1.x * 8.x versions (or b-7.0.x branch) are compatible with latest shop compilation: 7.0.x resp. b-7.0.x shop compilation branches * 7.x versions (or b-6.5.x branch) are compatible with latest shop compilations: 6.5.x resp. b-6.5.x shop compilation branches * 6.x versions (or b-6.4.x branch) are compatible with latest shop compilations: 6.4.x resp. b-6.4.x shop compilation branches @@ -36,10 +37,10 @@ This assumes you have OXID eShop (at least `OXID-eSales/oxideshop_ce: v7.0.0` co $ composer require oxid-esales/graphql-base ^8.0.0 ``` -You need to run migrations after the installation was successfully executed: +You should run migrations both after installing the module and after each module update: ```bash -$ vendor/bin/oe-eshop-doctrine_migration migration:migrate oe_graphql_base +$ vendor/bin/oe-eshop-doctrine_migration migrations:migrate oe_graphql_base ``` After requiring the module, you need to activate it, either via OXID eShop admin or CLI.