Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
- Loading branch information
Showing
22 changed files
with
443 additions
and
234 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| '@backstage/plugin-catalog': patch | ||
| --- | ||
|
|
||
| Deprecated the `CatalogClientWrapper` class. | ||
|
|
||
| The default implementation of `catalogApiRef` that this plugin exposes, is now powered by the new `fetchApiRef`. The default implementation of _that_ API, in turn, has the ability to inject the user's Backstage token in requests in a similar manner to what the deprecated `CatalogClientWrapper` used to do. The latter has therefore been taken out of the default catalog API implementation. | ||
|
|
||
| If you use a custom `fetchApiRef` implementation that does NOT issue tokens, or use a custom `catalogApiRef` implementation which does NOT use the default `fetchApiRef`, you can still for some time wrap your catalog API in this class to get back the old behavior: | ||
|
|
||
| ```ts | ||
| // Add this to your packages/app/src/plugins.ts if you want to get back the old | ||
| // catalog client behavior: | ||
| createApiFactory({ | ||
| api: catalogApiRef, | ||
| deps: { discoveryApi: discoveryApiRef, identityApi: identityApiRef }, | ||
| factory: ({ discoveryApi, identityApi }) => | ||
| new CatalogClientWrapper({ | ||
| client: new CatalogClient({ discoveryApi }), | ||
| identityApi, | ||
| }), | ||
| }), | ||
| ``` | ||
|
|
||
| But do consider migrating to making use of the `fetchApiRef` as soon as convenient, since the wrapper class will be removed in a future release. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
76 changes: 76 additions & 0 deletions
76
packages/core-app-api/src/apis/implementations/FetchApi/FetchMiddlewares.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| /* | ||
| * Copyright 2021 The Backstage Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import { Config } from '@backstage/config'; | ||
| import { DiscoveryApi, IdentityApi } from '@backstage/core-plugin-api'; | ||
| import { IdentityAuthInjectorFetchMiddleware } from './IdentityAuthInjectorFetchMiddleware'; | ||
| import { PluginProtocolResolverFetchMiddleware } from './PluginProtocolResolverFetchMiddleware'; | ||
| import { FetchMiddleware } from './types'; | ||
|
|
||
| /** | ||
| * A collection of common middlewares for the FetchApi. | ||
| * | ||
| * @public | ||
| */ | ||
| export class FetchMiddlewares { | ||
| /** | ||
| * Handles translation from `plugin://` URLs to concrete http(s) URLs based on | ||
| * the discovery API. | ||
| * | ||
| * @remarks | ||
| * | ||
| * If the request is for `plugin://catalog/entities?filter=x=y`, the discovery | ||
| * API will be queried for `'catalog'`. If it returned | ||
| * `https://backstage.example.net/api/catalog`, the resulting query would be | ||
| * `https://backstage.example.net/api/catalog/entities?filter=x=y`. | ||
| * | ||
| * If the incoming URL protocol was not `plugin`, the request is just passed | ||
| * through verbatim to the underlying implementation. | ||
| */ | ||
| static resolvePluginProtocol(options: { | ||
| discoveryApi: DiscoveryApi; | ||
| }): FetchMiddleware { | ||
| return new PluginProtocolResolverFetchMiddleware(options.discoveryApi); | ||
| } | ||
|
|
||
| /** | ||
| * Injects a Backstage token header when the user is signed in. | ||
| * | ||
| * @remarks | ||
| * | ||
| * Per default, an `Authorization: Bearer <token>` is generated. This can be | ||
| * customized using the `header` option. | ||
| * | ||
| * The header injection only happens on allowlisted URLs. Per default, if the | ||
| * `config` option is passed in, the `backend.baseUrl` is allowlisted, unless | ||
| * the `urlPrefixAllowlist` option is passed in, in which case it takes | ||
| * precedence. If you pass in neither config nor an allowlist, the middleware | ||
| * will have no effect. | ||
| */ | ||
| static injectIdentityAuth(options: { | ||
| identityApi: IdentityApi; | ||
| config?: Config; | ||
| urlPrefixAllowlist?: string[]; | ||
| header?: { | ||
| name: string; | ||
| value: (backstageToken: string) => string; | ||
| }; | ||
| }): FetchMiddleware { | ||
| return IdentityAuthInjectorFetchMiddleware.create(options); | ||
| } | ||
|
|
||
| private constructor() {} | ||
| } |
Oops, something went wrong.