From 9db0a0dc7c32690f11b957a1a3ff85e69649e8bb Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Tue, 20 Dec 2022 13:00:18 +0200 Subject: [PATCH 1/8] Removes connectUi5Proxy documentation --- docs/pages/Server.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/pages/Server.md b/docs/pages/Server.md index ede4bcf6064..c67f4c46ba3 100644 --- a/docs/pages/Server.md +++ b/docs/pages/Server.md @@ -20,7 +20,6 @@ A project can also add custom middleware to the server by using the [Custom Serv | `testRunner` | See chapter [testRunner](#testrunner) | | `serveThemes` | See chapter [serveThemes](#servethemes) | | `versionInfo` | See chapter [versionInfo](#versioninfo) | -| `connectUi5Proxy` | See chapter [connectUi5Proxy](#connectui5proxy) | | `nonReadRequests` | See chapter [nonReadRequests](#nonreadrequests) | | `serveIndex` | See chapter [serveIndex](#serveindex) | @@ -64,9 +63,6 @@ Changes made to these `*.less` files while the server is running will automatica ### versionInfo Generates and serves the version info file `/resources/sap-ui-version.json`, which is required for several framework functionalities. -### connectUi5Proxy -Provides basic proxy functionality using the proxy offered by [`connect-openui5`](https://github.com/SAP/connect-openui5#proxy) under the endpoint `/proxy`. - ### nonReadRequests Answers all non-read requests (POST, PUT, DELETE, etc.) that have not been answered by any other middleware with the 404 "Not Found" status code . This signals the client that these operations are not supported by the server. From 4241703a10f3324382f726d971122e62e2da06d7 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Tue, 20 Dec 2022 13:32:10 +0200 Subject: [PATCH 2/8] Document breaking change --- docs/pages/Configuration.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/pages/Configuration.md b/docs/pages/Configuration.md index 77c08d665a4..40551c7a8b1 100644 --- a/docs/pages/Configuration.md +++ b/docs/pages/Configuration.md @@ -691,6 +691,7 @@ Unless otherwise noted in the table below, UI5 Tooling modules are backward comp Version | UI5 CLI Release --- | --- +[**3.0 [beta]**](https://sap.github.io/ui5-tooling/v3/updates/migrate-v3/) | v3.0.0+ **2.6** | v2.14.0+ **2.5** | v2.12.0+ **2.4** | v2.11.0+ @@ -702,6 +703,19 @@ Version | UI5 CLI Release **1.0** | v1.0.0+ **0.1** | v0.0.1+ +### Specification Version 3.0 [beta] + +!!! info + **Note:** UI5 Tooling version 3.0 is currently in development. If you wish to migrate to the latest UI5 Tooling, please check the [Upgrade Guide for v3](https://sap.github.io/ui5-tooling/v3/updates/migrate-v3/) + +**Breaking changes:** + +- Removes the `/proxy` endpoint and the corresponding +[**connectUi5Proxy**](https://sap.github.io/ui5-tooling/v2/pages/Server/#connectui5proxy) middleware from the standard [ui5-server](https://github.com/SAP/ui5-server). More sophisticated proxy solutions for [ui5-server](https://github.com/SAP/ui5-server) are already available in the form of custom middleware extensions from the UI5-community. For more information on how to transition your project to UI5 Tooling v3, please check the [v3 Migration Guide](https://sap.github.io/ui5-tooling/v3/updates/migrate-v3/) + + +Specification Version 3.0 projects are supported by [UI5 CLI](https://github.com/SAP/ui5-cli) v3.0.0 and above. + ### Specification Version 2.6 **Features:** From 2ab5acc09d2f96f2a443d47eaf13e50673facb3d Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Tue, 20 Dec 2022 13:45:45 +0200 Subject: [PATCH 3/8] Add connectUi5Proxy to the migration guide of v3 --- docs/updates/migrate-v3.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/updates/migrate-v3.md b/docs/updates/migrate-v3.md index d96f44fed97..fab7b8c30b7 100644 --- a/docs/updates/migrate-v3.md +++ b/docs/updates/migrate-v3.md @@ -126,3 +126,30 @@ The following processors have been removed: ^2^ Enabled for projects defining a [component preload configuration](../pages/Configuration.md#component-preload-generation) ^3^ Enabled in `self-contained` build, which disables `generateComponentPreload` and `generateLibraryPreload` ^4^ Enabled for projects defining a [bundle configuration](../pages/Configuration.md#custom-bundling) + +## Removal of Standard Middleware + +The following middlewares have been removed: + +- connectUi5Proxy + +**Middleware Migration** + +| UI5 Tooling v2 | UI5 Tooling v3 | Note | +| --------------------------- | --------------------------- | ------------------------- | +| connectUi5Proxy | *None* | More sophisticated proxy solutions for [ui5-server](https://github.com/SAP/ui5-server) are already available in the form of custom middleware extensions from the UI5-community. Please refactor any custom middleware that attaches to `beforeMiddleware` or `afterMiddleware` of `connectUi5Proxy` to reference some other middleware. | + + +**Updated list of standard middlewares:** + +- compression +- cors +- csp +- serveResources +- serveIndex +- discovery +- versionInfo +- **REMOVED** ~~connectUi5Proxy~~ +- serveThemes +- testRunner +- nonReadRequests \ No newline at end of file From 043474c9ce8eac8b64f26ef0d947793960241717 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Tue, 20 Dec 2022 15:09:35 +0200 Subject: [PATCH 4/8] Update docs/updates/migrate-v3.md Co-authored-by: Florian Vogt --- docs/updates/migrate-v3.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/updates/migrate-v3.md b/docs/updates/migrate-v3.md index fab7b8c30b7..cd930f3bd34 100644 --- a/docs/updates/migrate-v3.md +++ b/docs/updates/migrate-v3.md @@ -137,7 +137,7 @@ The following middlewares have been removed: | UI5 Tooling v2 | UI5 Tooling v3 | Note | | --------------------------- | --------------------------- | ------------------------- | -| connectUi5Proxy | *None* | More sophisticated proxy solutions for [ui5-server](https://github.com/SAP/ui5-server) are already available in the form of custom middleware extensions from the UI5-community. Please refactor any custom middleware that attaches to `beforeMiddleware` or `afterMiddleware` of `connectUi5Proxy` to reference some other middleware. | +| connectUi5Proxy | *None* | More sophisticated proxy solutions for [ui5-server](https://github.com/SAP/ui5-server) are already available in the form of custom middleware extensions from the UI5-community. Please refactor any custom middleware that attaches to `beforeMiddleware` or `afterMiddleware` of `connectUi5Proxy` to reference some other middleware. | **Updated list of standard middlewares:** From 00e8d985af1781508b154cbd9e9001232b80effc Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Tue, 20 Dec 2022 15:09:43 +0200 Subject: [PATCH 5/8] Update docs/pages/Configuration.md Co-authored-by: Florian Vogt --- docs/pages/Configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/Configuration.md b/docs/pages/Configuration.md index 40551c7a8b1..a3cade973f5 100644 --- a/docs/pages/Configuration.md +++ b/docs/pages/Configuration.md @@ -711,7 +711,7 @@ Version | UI5 CLI Release **Breaking changes:** - Removes the `/proxy` endpoint and the corresponding -[**connectUi5Proxy**](https://sap.github.io/ui5-tooling/v2/pages/Server/#connectui5proxy) middleware from the standard [ui5-server](https://github.com/SAP/ui5-server). More sophisticated proxy solutions for [ui5-server](https://github.com/SAP/ui5-server) are already available in the form of custom middleware extensions from the UI5-community. For more information on how to transition your project to UI5 Tooling v3, please check the [v3 Migration Guide](https://sap.github.io/ui5-tooling/v3/updates/migrate-v3/) +[**connectUi5Proxy**](https://sap.github.io/ui5-tooling/v2/pages/Server/#connectui5proxy) middleware from the standard [ui5-server](https://github.com/SAP/ui5-server). More sophisticated proxy solutions for [ui5-server](https://github.com/SAP/ui5-server) are already available in the form of custom middleware extensions from the UI5-community. For more information on how to transition your project to UI5 Tooling v3, please check the [v3 Migration Guide](https://sap.github.io/ui5-tooling/v3/updates/migrate-v3/) Specification Version 3.0 projects are supported by [UI5 CLI](https://github.com/SAP/ui5-cli) v3.0.0 and above. From 4a379ac44762a6acea415de70985af9e095110d9 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Wed, 21 Dec 2022 10:15:09 +0200 Subject: [PATCH 6/8] Update migration guide --- docs/updates/migrate-v3.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/updates/migrate-v3.md b/docs/updates/migrate-v3.md index cd930f3bd34..c3f8287b065 100644 --- a/docs/updates/migrate-v3.md +++ b/docs/updates/migrate-v3.md @@ -137,7 +137,7 @@ The following middlewares have been removed: | UI5 Tooling v2 | UI5 Tooling v3 | Note | | --------------------------- | --------------------------- | ------------------------- | -| connectUi5Proxy | *None* | More sophisticated proxy solutions for [ui5-server](https://github.com/SAP/ui5-server) are already available in the form of custom middleware extensions from the UI5-community. Please refactor any custom middleware that attaches to `beforeMiddleware` or `afterMiddleware` of `connectUi5Proxy` to reference some other middleware. | +| connectUi5Proxy | *None* | More sophisticated proxy solutions for ui5-server are already available in the form of [custom middleware extensions from the UI5-community](https://bestofui5.org/#/packages?tokens=proxy:tag). Please refactor any custom middleware that attaches to `beforeMiddleware` or `afterMiddleware` of `connectUi5Proxy` to reference some other middleware. | **Updated list of standard middlewares:** From 7e17277827cd25186f76ac950689d9e8da68f72e Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Wed, 21 Dec 2022 13:00:08 +0200 Subject: [PATCH 7/8] Do not touch specVersions --- docs/pages/Configuration.md | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/docs/pages/Configuration.md b/docs/pages/Configuration.md index a3cade973f5..77c08d665a4 100644 --- a/docs/pages/Configuration.md +++ b/docs/pages/Configuration.md @@ -691,7 +691,6 @@ Unless otherwise noted in the table below, UI5 Tooling modules are backward comp Version | UI5 CLI Release --- | --- -[**3.0 [beta]**](https://sap.github.io/ui5-tooling/v3/updates/migrate-v3/) | v3.0.0+ **2.6** | v2.14.0+ **2.5** | v2.12.0+ **2.4** | v2.11.0+ @@ -703,19 +702,6 @@ Version | UI5 CLI Release **1.0** | v1.0.0+ **0.1** | v0.0.1+ -### Specification Version 3.0 [beta] - -!!! info - **Note:** UI5 Tooling version 3.0 is currently in development. If you wish to migrate to the latest UI5 Tooling, please check the [Upgrade Guide for v3](https://sap.github.io/ui5-tooling/v3/updates/migrate-v3/) - -**Breaking changes:** - -- Removes the `/proxy` endpoint and the corresponding -[**connectUi5Proxy**](https://sap.github.io/ui5-tooling/v2/pages/Server/#connectui5proxy) middleware from the standard [ui5-server](https://github.com/SAP/ui5-server). More sophisticated proxy solutions for [ui5-server](https://github.com/SAP/ui5-server) are already available in the form of custom middleware extensions from the UI5-community. For more information on how to transition your project to UI5 Tooling v3, please check the [v3 Migration Guide](https://sap.github.io/ui5-tooling/v3/updates/migrate-v3/) - - -Specification Version 3.0 projects are supported by [UI5 CLI](https://github.com/SAP/ui5-cli) v3.0.0 and above. - ### Specification Version 2.6 **Features:** From 05aa2a84165c1bf162b5b1e197176c7109b1c211 Mon Sep 17 00:00:00 2001 From: Yavor Ivanov Date: Thu, 22 Dec 2022 14:13:48 +0200 Subject: [PATCH 8/8] Clean up migration v3 guide --- docs/updates/migrate-v3.md | 17 +---------------- 1 file changed, 1 insertion(+), 16 deletions(-) diff --git a/docs/updates/migrate-v3.md b/docs/updates/migrate-v3.md index c3f8287b065..5436a10662e 100644 --- a/docs/updates/migrate-v3.md +++ b/docs/updates/migrate-v3.md @@ -129,7 +129,7 @@ The following processors have been removed: ## Removal of Standard Middleware -The following middlewares have been removed: +The following middlewares have been removed from the [standard middlewares list](../../pages/Server/#standard-middleware): - connectUi5Proxy @@ -138,18 +138,3 @@ The following middlewares have been removed: | UI5 Tooling v2 | UI5 Tooling v3 | Note | | --------------------------- | --------------------------- | ------------------------- | | connectUi5Proxy | *None* | More sophisticated proxy solutions for ui5-server are already available in the form of [custom middleware extensions from the UI5-community](https://bestofui5.org/#/packages?tokens=proxy:tag). Please refactor any custom middleware that attaches to `beforeMiddleware` or `afterMiddleware` of `connectUi5Proxy` to reference some other middleware. | - - -**Updated list of standard middlewares:** - -- compression -- cors -- csp -- serveResources -- serveIndex -- discovery -- versionInfo -- **REMOVED** ~~connectUi5Proxy~~ -- serveThemes -- testRunner -- nonReadRequests \ No newline at end of file