@atlaskit/media-client 35.6.1 → 35.7.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/media-client
 
+## 35.7.0
+
+### Minor Changes
+
+- [`a9118006d1586`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/a9118006d1586) -
+  Add auth provider analytics events via globalMediaEventEmitter behind
+  platform_media_auth_provider_analytics feature flag.
+
 ## 35.6.1
 
 ### Patch Changes

package/dist/cjs/client/media-store/resolveAuth.js

@@ -7,48 +7,91 @@ Object.defineProperty(exports, "__esModule", {
 exports.resolveInitialAuth = exports.resolveAuth = exports.DEFAULT_AUTH_PROVIDER_TIMEOUT = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _error = require("./error");
 var _setTimeoutPromise = require("../../utils/setTimeoutPromise");
+var _globalMediaEventEmitter = require("../../globalMediaEventEmitter");
 var DEFAULT_AUTH_PROVIDER_TIMEOUT = exports.DEFAULT_AUTH_PROVIDER_TIMEOUT = 10000;
 var resolveAuth = exports.resolveAuth = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(authProvider, authContext) {
     var authProviderTimeout,
+      startTime,
+      eventEmitted,
+      authProviderPromise,
       auth,
       _args = arguments;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
           authProviderTimeout = _args.length > 2 && _args[2] !== undefined ? _args[2] : DEFAULT_AUTH_PROVIDER_TIMEOUT;
-          _context.prev = 1;
-          _context.next = 4;
-          return Promise.race([authProvider(authContext), (0, _setTimeoutPromise.rejectTimeout)(authProviderTimeout, new _error.MediaStoreError('authProviderTimedOut'))]);
-        case 4:
+          startTime = performance.now();
+          eventEmitted = false; // Feature flag: wrap authProvider with analytics event emission
+          authProviderPromise = (0, _platformFeatureFlags.fg)('platform_media_auth_provider_analytics') ? authProvider(authContext).then(function (result) {
+            var durationMs = performance.now() - startTime;
+            if (!eventEmitted) {
+              eventEmitted = true;
+              _globalMediaEventEmitter.globalMediaEventEmitter.emit('auth-provider-succeeded', {
+                durationMs: durationMs,
+                timeoutMs: authProviderTimeout,
+                authContext: authContext
+              });
+            } else {
+              // Timeout already fired - auth arrived too late
+              var timeoutError = new _error.MediaStoreError('authProviderTimedOut');
+              _globalMediaEventEmitter.globalMediaEventEmitter.emit('auth-provider-failed', {
+                durationMs: durationMs,
+                timeoutMs: authProviderTimeout,
+                authContext: authContext,
+                error: timeoutError
+              });
+            }
+            return result;
+          }).catch(function (error) {
+            var durationMs = performance.now() - startTime;
+            eventEmitted = true;
+            _globalMediaEventEmitter.globalMediaEventEmitter.emit('auth-provider-failed', {
+              durationMs: durationMs,
+              timeoutMs: authProviderTimeout,
+              authContext: authContext,
+              error: error
+            });
+            throw error;
+          }) : authProvider(authContext); // Original behavior when FG off
+          _context.prev = 4;
+          _context.next = 7;
+          return Promise.race([authProviderPromise, (0, _setTimeoutPromise.rejectTimeout)(authProviderTimeout, new _error.MediaStoreError('authProviderTimedOut'))]);
+        case 7:
           auth = _context.sent;
-          _context.next = 12;
+          _context.next = 16;
           break;
-        case 7:
-          _context.prev = 7;
-          _context.t0 = _context["catch"](1);
+        case 10:
+          _context.prev = 10;
+          _context.t0 = _context["catch"](4);
+          // Mark as emitted so late arrivals are handled correctly by .then()/.catch()
+          if (!eventEmitted && (0, _platformFeatureFlags.fg)('platform_media_auth_provider_analytics')) {
+            eventEmitted = true;
+          }
+          // PRESERVE ORIGINAL ERROR HANDLING
           if (!(_context.t0 instanceof _error.MediaStoreError)) {
-            _context.next = 11;
+            _context.next = 15;
             break;
           }
           throw _context.t0;
-        case 11:
+        case 15:
           throw new _error.MediaStoreError('failedAuthProvider', _context.t0 instanceof Error ? _context.t0 : undefined);
-        case 12:
+        case 16:
           if (auth) {
-            _context.next = 14;
+            _context.next = 18;
             break;
           }
           throw new _error.MediaStoreError('emptyAuth');
-        case 14:
+        case 18:
           return _context.abrupt("return", auth);
-        case 15:
+        case 19:
         case "end":
           return _context.stop();
       }
-    }, _callee, null, [[1, 7]]);
+    }, _callee, null, [[4, 10]]);
   }));
   return function resolveAuth(_x, _x2) {
     return _ref.apply(this, arguments);

package/dist/es2019/client/media-store/resolveAuth.js

@@ -1,11 +1,54 @@
+import { fg } from '@atlaskit/platform-feature-flags';
 import { MediaStoreError } from './error';
 import { rejectTimeout } from '../../utils/setTimeoutPromise';
+import { globalMediaEventEmitter } from '../../globalMediaEventEmitter';
 export const DEFAULT_AUTH_PROVIDER_TIMEOUT = 10000;
 export const resolveAuth = async (authProvider, authContext, authProviderTimeout = DEFAULT_AUTH_PROVIDER_TIMEOUT) => {
+  const startTime = performance.now();
+  let eventEmitted = false;
+
+  // Feature flag: wrap authProvider with analytics event emission
+  const authProviderPromise = fg('platform_media_auth_provider_analytics') ? authProvider(authContext).then(result => {
+    const durationMs = performance.now() - startTime;
+    if (!eventEmitted) {
+      eventEmitted = true;
+      globalMediaEventEmitter.emit('auth-provider-succeeded', {
+        durationMs,
+        timeoutMs: authProviderTimeout,
+        authContext
+      });
+    } else {
+      // Timeout already fired - auth arrived too late
+      const timeoutError = new MediaStoreError('authProviderTimedOut');
+      globalMediaEventEmitter.emit('auth-provider-failed', {
+        durationMs,
+        timeoutMs: authProviderTimeout,
+        authContext,
+        error: timeoutError
+      });
+    }
+    return result;
+  }).catch(error => {
+    const durationMs = performance.now() - startTime;
+    eventEmitted = true;
+    globalMediaEventEmitter.emit('auth-provider-failed', {
+      durationMs,
+      timeoutMs: authProviderTimeout,
+      authContext,
+      error
+    });
+    throw error;
+  }) : authProvider(authContext); // Original behavior when FG off
+
   let auth;
   try {
-    auth = await Promise.race([authProvider(authContext), rejectTimeout(authProviderTimeout, new MediaStoreError('authProviderTimedOut'))]);
+    auth = await Promise.race([authProviderPromise, rejectTimeout(authProviderTimeout, new MediaStoreError('authProviderTimedOut'))]);
   } catch (err) {
+    // Mark as emitted so late arrivals are handled correctly by .then()/.catch()
+    if (!eventEmitted && fg('platform_media_auth_provider_analytics')) {
+      eventEmitted = true;
+    }
+    // PRESERVE ORIGINAL ERROR HANDLING
     if (err instanceof MediaStoreError) {
       throw err;
     }

package/dist/esm/client/media-store/resolveAuth.js

@@ -1,47 +1,90 @@
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { fg } from '@atlaskit/platform-feature-flags';
 import { MediaStoreError } from './error';
 import { rejectTimeout } from '../../utils/setTimeoutPromise';
+import { globalMediaEventEmitter } from '../../globalMediaEventEmitter';
 export var DEFAULT_AUTH_PROVIDER_TIMEOUT = 10000;
 export var resolveAuth = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(authProvider, authContext) {
     var authProviderTimeout,
+      startTime,
+      eventEmitted,
+      authProviderPromise,
       auth,
       _args = arguments;
     return _regeneratorRuntime.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
           authProviderTimeout = _args.length > 2 && _args[2] !== undefined ? _args[2] : DEFAULT_AUTH_PROVIDER_TIMEOUT;
-          _context.prev = 1;
-          _context.next = 4;
-          return Promise.race([authProvider(authContext), rejectTimeout(authProviderTimeout, new MediaStoreError('authProviderTimedOut'))]);
-        case 4:
+          startTime = performance.now();
+          eventEmitted = false; // Feature flag: wrap authProvider with analytics event emission
+          authProviderPromise = fg('platform_media_auth_provider_analytics') ? authProvider(authContext).then(function (result) {
+            var durationMs = performance.now() - startTime;
+            if (!eventEmitted) {
+              eventEmitted = true;
+              globalMediaEventEmitter.emit('auth-provider-succeeded', {
+                durationMs: durationMs,
+                timeoutMs: authProviderTimeout,
+                authContext: authContext
+              });
+            } else {
+              // Timeout already fired - auth arrived too late
+              var timeoutError = new MediaStoreError('authProviderTimedOut');
+              globalMediaEventEmitter.emit('auth-provider-failed', {
+                durationMs: durationMs,
+                timeoutMs: authProviderTimeout,
+                authContext: authContext,
+                error: timeoutError
+              });
+            }
+            return result;
+          }).catch(function (error) {
+            var durationMs = performance.now() - startTime;
+            eventEmitted = true;
+            globalMediaEventEmitter.emit('auth-provider-failed', {
+              durationMs: durationMs,
+              timeoutMs: authProviderTimeout,
+              authContext: authContext,
+              error: error
+            });
+            throw error;
+          }) : authProvider(authContext); // Original behavior when FG off
+          _context.prev = 4;
+          _context.next = 7;
+          return Promise.race([authProviderPromise, rejectTimeout(authProviderTimeout, new MediaStoreError('authProviderTimedOut'))]);
+        case 7:
           auth = _context.sent;
-          _context.next = 12;
+          _context.next = 16;
           break;
-        case 7:
-          _context.prev = 7;
-          _context.t0 = _context["catch"](1);
+        case 10:
+          _context.prev = 10;
+          _context.t0 = _context["catch"](4);
+          // Mark as emitted so late arrivals are handled correctly by .then()/.catch()
+          if (!eventEmitted && fg('platform_media_auth_provider_analytics')) {
+            eventEmitted = true;
+          }
+          // PRESERVE ORIGINAL ERROR HANDLING
           if (!(_context.t0 instanceof MediaStoreError)) {
-            _context.next = 11;
+            _context.next = 15;
             break;
           }
           throw _context.t0;
-        case 11:
+        case 15:
           throw new MediaStoreError('failedAuthProvider', _context.t0 instanceof Error ? _context.t0 : undefined);
-        case 12:
+        case 16:
           if (auth) {
-            _context.next = 14;
+            _context.next = 18;
             break;
           }
           throw new MediaStoreError('emptyAuth');
-        case 14:
+        case 18:
           return _context.abrupt("return", auth);
-        case 15:
+        case 19:
         case "end":
           return _context.stop();
       }
-    }, _callee, null, [[1, 7]]);
+    }, _callee, null, [[4, 10]]);
   }));
   return function resolveAuth(_x, _x2) {
     return _ref.apply(this, arguments);

package/dist/types/client/events.d.ts

@@ -1,4 +1,5 @@
 import { type FileState } from '@atlaskit/media-state';
+import { type AuthContext } from '@atlaskit/media-core';
 export type EventPayloadMap<P> = {
     readonly [event: string]: P;
 };
@@ -8,7 +9,20 @@ export interface MediaViewedEventPayload {
     viewingLevel: 'minimal' | 'full' | 'download';
     isUserCollection?: boolean;
 }
+export interface AuthProviderSucceededEventPayload {
+    durationMs: number;
+    timeoutMs: number;
+    authContext?: AuthContext;
+}
+export interface AuthProviderFailedEventPayload {
+    durationMs: number;
+    timeoutMs: number;
+    authContext?: AuthContext;
+    error: Error;
+}
 export type UploadEventPayloadMap = {
     'file-added': FileState;
     'media-viewed': MediaViewedEventPayload;
+    'auth-provider-succeeded': AuthProviderSucceededEventPayload;
+    'auth-provider-failed': AuthProviderFailedEventPayload;
 };

package/dist/types/index.d.ts

@@ -33,7 +33,7 @@ export type { Dimensions } from './utils/getDimensionsFromBlob';
 export { createMediaSubject } from './utils/createMediaSubject';
 export { isFileIdentifier, isExternalImageIdentifier, isDifferentIdentifier } from './identifier';
 export type { Identifier, FileIdentifier, ExternalImageIdentifier } from './identifier';
-export type { EventPayloadListener, UploadEventPayloadMap, MediaViewedEventPayload, } from './client/events';
+export type { EventPayloadListener, UploadEventPayloadMap, MediaViewedEventPayload, AuthProviderSucceededEventPayload, AuthProviderFailedEventPayload, } from './client/events';
 export type { MediaClientConfig } from '@atlaskit/media-core';
 export { globalMediaEventEmitter } from './globalMediaEventEmitter';
 export { isMediaBlobUrl, getAttrsFromUrl, addFileAttrsToUrl, objectToQueryString, } from './utils/url';

package/dist/types-ts4.5/client/events.d.ts

@@ -1,4 +1,5 @@
 import { type FileState } from '@atlaskit/media-state';
+import { type AuthContext } from '@atlaskit/media-core';
 export type EventPayloadMap<P> = {
     readonly [event: string]: P;
 };
@@ -8,7 +9,20 @@ export interface MediaViewedEventPayload {
     viewingLevel: 'minimal' | 'full' | 'download';
     isUserCollection?: boolean;
 }
+export interface AuthProviderSucceededEventPayload {
+    durationMs: number;
+    timeoutMs: number;
+    authContext?: AuthContext;
+}
+export interface AuthProviderFailedEventPayload {
+    durationMs: number;
+    timeoutMs: number;
+    authContext?: AuthContext;
+    error: Error;
+}
 export type UploadEventPayloadMap = {
     'file-added': FileState;
     'media-viewed': MediaViewedEventPayload;
+    'auth-provider-succeeded': AuthProviderSucceededEventPayload;
+    'auth-provider-failed': AuthProviderFailedEventPayload;
 };

package/dist/types-ts4.5/index.d.ts

@@ -33,7 +33,7 @@ export type { Dimensions } from './utils/getDimensionsFromBlob';
 export { createMediaSubject } from './utils/createMediaSubject';
 export { isFileIdentifier, isExternalImageIdentifier, isDifferentIdentifier } from './identifier';
 export type { Identifier, FileIdentifier, ExternalImageIdentifier } from './identifier';
-export type { EventPayloadListener, UploadEventPayloadMap, MediaViewedEventPayload, } from './client/events';
+export type { EventPayloadListener, UploadEventPayloadMap, MediaViewedEventPayload, AuthProviderSucceededEventPayload, AuthProviderFailedEventPayload, } from './client/events';
 export type { MediaClientConfig } from '@atlaskit/media-core';
 export { globalMediaEventEmitter } from './globalMediaEventEmitter';
 export { isMediaBlobUrl, getAttrsFromUrl, addFileAttrsToUrl, objectToQueryString, } from './utils/url';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/media-client",
-	"version": "35.6.1",
+	"version": "35.7.0",
 	"description": "Media API Web Client Library",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -87,6 +87,9 @@
 		},
 		"platform_media_retry_edge_error": {
 			"type": "boolean"
+		},
+		"platform_media_auth_provider_analytics": {
+			"type": "boolean"
 		}
 	}
 }