@backstage/core-app-api 1.9.1 → 1.10.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @backstage/core-app-api
 
+## 1.10.0-next.0
+
+### Minor Changes
+
+- 18619f793c94: Fixed two bugs in how the `OAuth2Session` type represents the underlying data. The `expiresAt` and `backstageIdentity` are now both optional, since that's what they are in practice. This is not considered a breaking change since it was effectively a bug in the modelling of the state that this type represents, and the type was not used in any other external contract.
+- 18619f793c94: The `OAuth` class which is used by all OAuth providers will now consider both the session expiration of both the Backstage identity as well as the upstream identity provider, and refresh the session with either of them is about to expire.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-plugin-api@1.6.0-next.0
+  - @backstage/config@1.0.8
+  - @backstage/types@1.1.0
+  - @backstage/version-bridge@1.0.4
+
 ## 1.9.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ReactNode, PropsWithChildren, ComponentType } from 'react';
+import React, { ReactNode, PropsWithChildren, ComponentType } from 'react';
 import PropTypes from 'prop-types';
 import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
 import { ApiHolder, ApiRef, ApiFactory, AnyApiRef, OAuthRequestApi, DiscoveryApi, AuthProviderInfo, ConfigApi, githubAuthApiRef, gitlabAuthApiRef, googleAuthApiRef, OAuthApi, OpenIdConnectApi, ProfileInfoApi, BackstageIdentityApi, SessionApi, SessionState, AuthRequestOptions, BackstageIdentityResponse, ProfileInfo, oktaAuthApiRef, microsoftAuthApiRef, oneloginAuthApiRef, bitbucketAuthApiRef, bitbucketServerAuthApiRef, atlassianAuthApiRef, AlertApi, AlertMessage, AnalyticsApi, AnalyticsEvent, AppThemeApi, AppTheme, ErrorApi, ErrorApiError, ErrorApiErrorContext, FeatureFlagsApi, FeatureFlag, FeatureFlagsSaveOptions, FetchApi, IdentityApi, OAuthRequesterOptions, OAuthRequester, PendingOAuthRequest, StorageApi, StorageValueSnapshot, BackstagePlugin, IconComponent, ExternalRouteRef, AnyApiFactory, RouteRef, SubRouteRef } from '@backstage/core-plugin-api';
@@ -22,7 +22,7 @@ type ApiProviderProps = {
  * @public
  */
 declare const ApiProvider: {
-    (props: PropsWithChildren<ApiProviderProps>): JSX.Element;
+    (props: PropsWithChildren<ApiProviderProps>): React.JSX.Element;
     propTypes: {
         apis: PropTypes.Validator<NonNullable<PropTypes.InferProps<{
             get: PropTypes.Validator<(...args: any[]) => any>;
@@ -192,10 +192,10 @@ type OAuth2Session = {
         idToken: string;
         accessToken: string;
         scopes: Set<string>;
-        expiresAt: Date;
+        expiresAt?: Date;
     };
     profile: ProfileInfo;
-    backstageIdentity: BackstageIdentityResponse;
+    backstageIdentity?: BackstageIdentityResponse;
 };
 
 /**
@@ -671,7 +671,7 @@ interface AppRouterProps {
  * the sign-in page. Once the user has signed-in, it will instead render
  * the app, while providing routing and route tracking for the app.
  */
-declare function AppRouter(props: AppRouterProps): JSX.Element;
+declare function AppRouter(props: AppRouterProps): React.JSX.Element;
 
 /**
  * Props for the `BootErrorPage` component of {@link AppComponents}.
@@ -1048,6 +1048,6 @@ type FeatureFlaggedProps = {
  *
  * @public
  */
-declare const FeatureFlagged: (props: FeatureFlaggedProps) => JSX.Element;
+declare const FeatureFlagged: (props: FeatureFlaggedProps) => React.JSX.Element;
 
 export { AlertApiForwarder, ApiFactoryHolder, ApiFactoryRegistry, ApiFactoryScope, ApiProvider, ApiProviderProps, ApiResolver, AppComponents, AppConfigLoader, AppContext, AppIcons, AppOptions, AppRouteBinder, AppRouter, AppRouterProps, AppThemeSelector, AtlassianAuth, AuthApiCreateOptions, BackstageApp, BitbucketAuth, BitbucketServerAuth, BitbucketServerSession, BitbucketSession, BootErrorPageProps, ErrorAlerter, ErrorApiForwarder, ErrorBoundaryFallbackProps, FeatureFlagged, FeatureFlaggedProps, FetchMiddleware, FetchMiddlewares, FlatRoutes, FlatRoutesProps, FrontendHostDiscovery, GithubAuth, GitlabAuth, GoogleAuth, LocalStorageFeatureFlags, MicrosoftAuth, MultipleAnalyticsApi, NoOpAnalyticsApi, OAuth2, OAuth2CreateOptions, OAuth2Session, OAuthApiCreateOptions, OAuthRequestManager, OktaAuth, OneLoginAuth, OneLoginAuthCreateOptions, PopupOptions, SamlAuth, SignInPageProps, UnhandledErrorForwarder, UrlPatternDiscovery, WebStorage, createFetchApi, createSpecializedApp, defaultConfigLoader };

package/dist/index.esm.js

@@ -933,8 +933,12 @@ class OAuth2 {
       environment,
       provider,
       oauthRequestApi,
-      sessionTransform(res) {
-        return {
+      sessionTransform({
+        backstageIdentity,
+        ...res
+      }) {
+        var _a;
+        const session = {
           ...res,
           providerInfo: {
             idToken: res.providerInfo.idToken,
@@ -943,11 +947,18 @@ class OAuth2 {
               scopeTransform,
               res.providerInfo.scope
             ),
-            expiresAt: new Date(
-              Date.now() + res.providerInfo.expiresInSeconds * 1e3
-            )
+            expiresAt: res.providerInfo.expiresInSeconds ? new Date(Date.now() + res.providerInfo.expiresInSeconds * 1e3) : void 0
           }
         };
+        if (backstageIdentity) {
+          const expInSec = (_a = backstageIdentity.expiresInSeconds) != null ? _a : res.providerInfo.expiresInSeconds;
+          session.backstageIdentity = {
+            token: backstageIdentity.token,
+            identity: backstageIdentity.identity,
+            expiresAt: expInSec ? new Date(Date.now() + expInSec * 1e3) : void 0
+          };
+        }
+        return session;
       },
       popupOptions
     });
@@ -956,8 +967,21 @@ class OAuth2 {
       defaultScopes: new Set(defaultScopes),
       sessionScopes: (session) => session.providerInfo.scopes,
       sessionShouldRefresh: (session) => {
-        const expiresInSec = (session.providerInfo.expiresAt.getTime() - Date.now()) / 1e3;
-        return expiresInSec < 60 * 5;
+        var _a, _b;
+        let min = Infinity;
+        if ((_a = session.providerInfo) == null ? void 0 : _a.expiresAt) {
+          min = Math.min(
+            min,
+            (session.providerInfo.expiresAt.getTime() - Date.now()) / 1e3
+          );
+        }
+        if ((_b = session.backstageIdentity) == null ? void 0 : _b.expiresAt) {
+          min = Math.min(
+            min,
+            (session.backstageIdentity.expiresAt.getTime() - Date.now()) / 1e3
+          );
+        }
+        return min < 60 * 5;
       }
     });
     return new OAuth2({ sessionManager, scopeTransform });