@atlaskit/media-client 18.0.0 → 19.0.0

package/dist/cjs/utils/request/helpers.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.DEFAULT_RETRY_OPTIONS = void 0;
+exports.ZipkinHeaderKeys = exports.DEFAULT_RETRY_OPTIONS = void 0;
 exports.clientTimeoutPromise = clientTimeoutPromise;
 exports.cloneRequestError = cloneRequestError;
 exports.createMapResponseToBlob = createMapResponseToBlob;
@@ -14,6 +14,7 @@ exports.createProcessFetchResponse = createProcessFetchResponse;
 exports.createRequestErrorFromResponse = createRequestErrorFromResponse;
 exports.createRequestErrorReason = createRequestErrorReason;
 exports.createUrl = createUrl;
+exports.extendHeaders = extendHeaders;
 exports.extractMediaHeaders = extractMediaHeaders;
 exports.fetchRetry = fetchRetry;
 exports.isAbortedRequestError = isAbortedRequestError;
@@ -24,7 +25,6 @@ exports.mapResponseToBlob = mapResponseToBlob;
 exports.mapResponseToJson = mapResponseToJson;
 exports.mapResponseToVoid = mapResponseToVoid;
 exports.waitPromise = waitPromise;
-exports.withAuth = withAuth;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
@@ -71,7 +71,26 @@ function isRateLimitedError(error) {
   return !!error && (0, _errors.isRequestError)(error) && error.attributes.statusCode === 429 || !!error && !!error.message && error.message.includes('429');
 }
 
+var ZipkinHeaderKeys = {
+  traceId: 'x-b3-traceid',
+  spanId: 'x-b3-spanid',
+  parentSpanId: 'x-b3-parentspanid',
+  sampled: 'x-b3-sampled',
+  flags: 'x-b3-flags'
+};
+exports.ZipkinHeaderKeys = ZipkinHeaderKeys;
+
+var mapTraceIdToRequestHeaders = function mapTraceIdToRequestHeaders(traceContext) {
+  var _ref;
+
+  return traceContext ? (_ref = {}, (0, _defineProperty2.default)(_ref, ZipkinHeaderKeys.traceId, traceContext.traceId), (0, _defineProperty2.default)(_ref, ZipkinHeaderKeys.spanId, traceContext.spanId), _ref) : {};
+};
+
 function mapAuthToRequestHeaders(auth) {
+  if (!auth) {
+    return {};
+  }
+
   if ((0, _mediaCore.isClientBasedAuth)(auth)) {
     return {
       'X-Client-Id': auth.clientId,
@@ -85,18 +104,18 @@ function mapAuthToRequestHeaders(auth) {
   };
 }
 
-function createUrl(url, _ref) {
-  var params = _ref.params,
-      auth = _ref.auth;
+function createUrl(url, _ref2) {
+  var params = _ref2.params,
+      auth = _ref2.auth;
   var parsedUrl = new URL(url);
   var authParams = auth && (0, _authQueryParameters.mapAuthToQueryParameters)(auth) || {};
 
   var paramsToAppend = _objectSpread(_objectSpread({}, params), authParams);
 
-  Object.entries(paramsToAppend).filter(function (_ref2) {
-    var _ref3 = (0, _slicedToArray2.default)(_ref2, 2),
-        _ = _ref3[0],
-        value = _ref3[1];
+  Object.entries(paramsToAppend).filter(function (_ref3) {
+    var _ref4 = (0, _slicedToArray2.default)(_ref3, 2),
+        _ = _ref4[0],
+        value = _ref4[1];
 
     return value != null;
   }).forEach(function (pair) {
@@ -108,14 +127,12 @@ function createUrl(url, _ref) {
   return parsedUrl.toString();
 }
 
-function withAuth(auth) {
-  return function (headers) {
-    if (auth) {
-      return _objectSpread(_objectSpread({}, headers || {}), mapAuthToRequestHeaders(auth));
-    }
+function extendHeaders(headers, auth, traceContext) {
+  if (!auth && !traceContext && !headers) {
+    return undefined;
+  }
 
-    return headers;
-  };
+  return _objectSpread(_objectSpread(_objectSpread({}, headers !== null && headers !== void 0 ? headers : {}), mapAuthToRequestHeaders(auth)), mapTraceIdToRequestHeaders(traceContext));
 }
 /**
  * @deprecated Helper is deprecated and will be removed in the next major version.
@@ -213,7 +230,7 @@ function mapResponseToVoid() {
 
 function createMapResponseToJson(metadata) {
   return /*#__PURE__*/function () {
-    var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(response) {
+    var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(response) {
       return _regenerator.default.wrap(function _callee$(_context) {
         while (1) {
           switch (_context.prev = _context.next) {
@@ -241,14 +258,14 @@ function createMapResponseToJson(metadata) {
     }));
 
     return function (_x3) {
-      return _ref4.apply(this, arguments);
+      return _ref5.apply(this, arguments);
     };
   }();
 }
 
 function createMapResponseToBlob(metadata) {
   return /*#__PURE__*/function () {
-    var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(response) {
+    var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(response) {
       return _regenerator.default.wrap(function _callee2$(_context2) {
         while (1) {
           switch (_context2.prev = _context2.next) {
@@ -276,7 +293,7 @@ function createMapResponseToBlob(metadata) {
     }));
 
     return function (_x4) {
-      return _ref5.apply(this, arguments);
+      return _ref6.apply(this, arguments);
     };
   }();
 }
@@ -325,7 +342,7 @@ function _fetchRetry() {
             timeoutInMs = startTimeoutInMs;
 
             waitAndBumpTimeout = /*#__PURE__*/function () {
-              var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
+              var _ref7 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
                 return _regenerator.default.wrap(function _callee5$(_context5) {
                   while (1) {
                     switch (_context5.prev = _context5.next) {
@@ -346,7 +363,7 @@ function _fetchRetry() {
               }));
 
               return function waitAndBumpTimeout() {
-                return _ref6.apply(this, arguments);
+                return _ref7.apply(this, arguments);
               };
             }();
 

package/dist/cjs/utils/request/index.js

@@ -50,6 +50,7 @@ function _request() {
         body,
         _options$clientOption,
         clientOptions,
+        traceContext,
         retryOptions,
         metadata,
         doFetch,
@@ -61,7 +62,7 @@ function _request() {
           case 0:
             options = _args.length > 1 && _args[1] !== undefined ? _args[1] : {};
             controller = _args.length > 2 ? _args[2] : undefined;
-            _options$method = options.method, method = _options$method === void 0 ? 'GET' : _options$method, endpoint = options.endpoint, auth = options.auth, params = options.params, headers = options.headers, body = options.body, _options$clientOption = options.clientOptions, clientOptions = _options$clientOption === void 0 ? {} : _options$clientOption;
+            _options$method = options.method, method = _options$method === void 0 ? 'GET' : _options$method, endpoint = options.endpoint, auth = options.auth, params = options.params, headers = options.headers, body = options.body, _options$clientOption = options.clientOptions, clientOptions = _options$clientOption === void 0 ? {} : _options$clientOption, traceContext = options.traceContext;
             retryOptions = clientOptions.retryOptions;
             metadata = {
               method: method,
@@ -74,7 +75,7 @@ function _request() {
               }), {
                 method: method,
                 body: body,
-                headers: (0, _helpers.withAuth)(auth)(headers),
+                headers: (0, _helpers.extendHeaders)(headers, auth, traceContext),
                 signal: controller && controller.signal
               }).then((0, _helpers.createProcessFetchResponse)(metadata));
             };

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/media-client",
-	"version": "18.0.0",
+	"version": "19.0.0",
 	"sideEffects": false
 }

package/dist/es2019/client/collection-fetcher.js

@@ -46,7 +46,7 @@ export class CollectionFetcher {
     collectionCache[collectionName].items.splice(collectionCacheIndex, 1);
   }
 
-  getItems(collectionName, params) {
+  getItems(collectionName, params, traceContext) {
     if (!collectionCache[collectionName]) {
       collectionCache[collectionName] = createCacheEntry();
     }
@@ -55,7 +55,7 @@ export class CollectionFetcher {
     const subject = collection.subject;
     this.mediaStore.getCollectionItems(collectionName, { ...params,
       details: 'full'
-    }).then(items => {
+    }, traceContext).then(items => {
       const {
         contents,
         nextInclusiveStartKey
@@ -70,14 +70,14 @@ export class CollectionFetcher {
     return fromObservable(subject);
   }
 
-  async removeFile(id, collectionName, occurrenceKey) {
-    await this.mediaStore.removeCollectionFile(id, collectionName, occurrenceKey);
+  async removeFile(id, collectionName, occurrenceKey, traceContext) {
+    await this.mediaStore.removeCollectionFile(id, collectionName, occurrenceKey, traceContext);
     this.removeFromCache(id, collectionName);
     const collection = collectionCache[collectionName];
     collection.subject.next(collection.items);
   }
 
-  async loadNextPage(collectionName, params) {
+  async loadNextPage(collectionName, params, traceContext) {
     const collection = collectionCache[collectionName];
     const isLoading = collection ? collection.isLoadingNextPage : false;
 
@@ -94,7 +94,7 @@ export class CollectionFetcher {
     const response = await this.mediaStore.getCollectionItems(collectionName, { ...params,
       inclusiveStartKey,
       details: 'full'
-    });
+    }, traceContext);
     const {
       contents,
       nextInclusiveStartKey

package/dist/es2019/client/file-fetcher/index.js

@@ -106,19 +106,20 @@ export class FileFetcherImpl {
 
   getFileBinaryURL(id, collectionName) {
     return this.mediaStore.getFileBinaryURL(id, collectionName);
-  }
+  } // TODO: ----- ADD TICKET TO PASS TRACE ID to this.dataloader.load
+
 
-  touchFiles(descriptors, collection) {
+  touchFiles(descriptors, collection, traceContext) {
     return this.mediaStore.touchFiles({
       descriptors
     }, {
       collection
-    }).then(({
+    }, traceContext).then(({
       data
     }) => data);
   }
 
-  generateUploadableFileUpfrontIds(collection) {
+  generateUploadableFileUpfrontIds(collection, traceContext) {
     const id = uuid();
     const occurrenceKey = uuid();
     const touchFileDescriptor = {
@@ -126,7 +127,7 @@ export class FileFetcherImpl {
       occurrenceKey,
       collection
     };
-    const deferredUploadId = this.touchFiles([touchFileDescriptor], collection).then(touchedFiles => touchedFiles.created[0].uploadId);
+    const deferredUploadId = this.touchFiles([touchFileDescriptor], collection, traceContext).then(touchedFiles => touchedFiles.created[0].uploadId);
     return {
       id,
       occurrenceKey,
@@ -134,8 +135,8 @@ export class FileFetcherImpl {
     };
   }
 
-  async uploadExternal(url, collection) {
-    const uploadableFileUpfrontIds = this.generateUploadableFileUpfrontIds(collection);
+  async uploadExternal(url, collection, traceContext) {
+    const uploadableFileUpfrontIds = this.generateUploadableFileUpfrontIds(collection, traceContext);
     const {
       id,
       occurrenceKey
@@ -199,7 +200,7 @@ export class FileFetcherImpl {
         preview
       }); // we don't want to wait for the file to be upload
 
-      this.upload(file, undefined, uploadableFileUpfrontIds);
+      this.upload(file, undefined, uploadableFileUpfrontIds, traceContext);
       const dimensions = await getDimensionsFromBlob(mediaType, blob);
       resolve({
         dimensions,
@@ -208,7 +209,7 @@ export class FileFetcherImpl {
     });
   }
 
-  upload(file, controller, uploadableFileUpfrontIds) {
+  upload(file, controller, uploadableFileUpfrontIds, traceContext) {
     if (typeof file.content === 'string') {
       file.content = convertBase64ToBlob(file.content);
     }
@@ -221,7 +222,7 @@ export class FileFetcherImpl {
     } = file;
 
     if (!uploadableFileUpfrontIds) {
-      uploadableFileUpfrontIds = this.generateUploadableFileUpfrontIds(collection);
+      uploadableFileUpfrontIds = this.generateUploadableFileUpfrontIds(collection, traceContext);
     }
 
     const id = uploadableFileUpfrontIds.id;
@@ -291,7 +292,7 @@ export class FileFetcherImpl {
     } = uploadFile(file, this.mediaStore, uploadableFileUpfrontIds, {
       onUploadFinish,
       onProgress
-    });
+    }, traceContext);
     getFileStreamsCache().set(id, subject); // We should report progress asynchronously, since this is what consumer expects
     // (otherwise in newUploadService file-converting event will be emitted before files-added)
 
@@ -307,7 +308,8 @@ export class FileFetcherImpl {
     }
 
     return fromObservable(subject);
-  }
+  } // TODO: ----- ADD TICKET
+
 
   async downloadBinary(id, name = 'download', collectionName) {
     const url = await this.mediaStore.getFileBinaryURL(id, collectionName);
@@ -321,7 +323,7 @@ export class FileFetcherImpl {
     });
   }
 
-  async copyFile(source, destination, options = {}) {
+  async copyFile(source, destination, options = {}, traceContext) {
     const {
       authProvider,
       collection: sourceCollection,
@@ -361,7 +363,7 @@ export class FileFetcherImpl {
     try {
       const {
         data: copiedFile
-      } = await mediaStore.copyFileWithToken(body, params); // if we were passed a "mimeType", we propagate it into copiedFileWithMimeType
+      } = await mediaStore.copyFileWithToken(body, params, traceContext); // if we were passed a "mimeType", we propagate it into copiedFileWithMimeType
 
       const copiedFileWithMimeType = { ...copiedFile,
         ...(mimeType ? {

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

@@ -20,8 +20,8 @@ export class MediaClient {
     this.stargate = new StargateClient(mediaClientConfig.stargateBaseUrl);
   }
 
-  getImage(id, params, controller, fetchMaxRes) {
-    return this.mediaStore.getImage(id, params, controller, fetchMaxRes);
+  getImage(id, params, controller, fetchMaxRes, traceContext) {
+    return this.mediaStore.getImage(id, params, controller, fetchMaxRes, traceContext);
   }
 
   getImageUrl(id, params) {

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

@@ -1,4 +1,5 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { getRandomHex } from '@atlaskit/media-common';
 import { FILE_CACHE_MAX_AGE, MAX_RESOLUTION } from '../../constants';
 import { getArtifactUrl } from '../../models/artifacts';
 import { request } from '../../utils/request';
@@ -41,7 +42,7 @@ export class MediaStore {
     this.featureFlags = featureFlags;
   }
 
-  async getCollectionItems(collectionName, params) {
+  async getCollectionItems(collectionName, params, traceContext) {
     const metadata = {
       method: 'GET',
       endpoint: '/collection/{collectionName}/items'
@@ -55,7 +56,8 @@ export class MediaStore {
       },
       headers: {
         Accept: 'application/json'
-      }
+      },
+      traceContext
     };
     const response = await this.request(`/collection/${collectionName}/items`, options);
     const {
@@ -75,7 +77,7 @@ export class MediaStore {
     };
   }
 
-  async removeCollectionFile(id, collectionName, occurrenceKey) {
+  async removeCollectionFile(id, collectionName, occurrenceKey, traceContext) {
     const metadata = {
       method: 'PUT',
       endpoint: '/collection/{collectionName}'
@@ -98,12 +100,13 @@ export class MediaStore {
         Accept: 'application/json',
         'Content-Type': 'application/json'
       },
-      body: JSON.stringify(body)
+      body: JSON.stringify(body),
+      traceContext
     };
     await this.request(`/collection/${collectionName}`, options);
   }
 
-  createUpload(createUpTo = 1, collectionName) {
+  createUpload(createUpTo = 1, collectionName, traceContext) {
     const metadata = {
       method: 'POST',
       endpoint: '/upload'
@@ -117,7 +120,8 @@ export class MediaStore {
       },
       headers: {
         Accept: 'application/json'
-      }
+      },
+      traceContext
     };
     return this.request(`/upload`, options).then(createMapResponseToJson(metadata));
   }
@@ -126,7 +130,7 @@ export class MediaStore {
     collectionName,
     uploadId,
     partNumber
-  } = {}) {
+  } = {}, traceContext) {
     const metadata = {
       method: 'PUT',
       endpoint: '/chunk/{etag}'
@@ -139,7 +143,8 @@ export class MediaStore {
       authContext: {
         collectionName
       },
-      body: blob
+      body: blob,
+      traceContext
     };
     await this.request(`/chunk/${etag}`, options);
   }
@@ -147,7 +152,7 @@ export class MediaStore {
   probeChunks(chunks, {
     collectionName,
     uploadId
-  } = {}) {
+  } = {}, traceContext) {
     const metadata = {
       method: 'POST',
       endpoint: '/chunk/probe'
@@ -162,12 +167,13 @@ export class MediaStore {
       headers: jsonHeaders,
       body: JSON.stringify({
         chunks
-      })
+      }),
+      traceContext
     };
     return this.request(`/chunk/probe`, options).then(createMapResponseToJson(metadata));
   }
 
-  createFileFromUpload(body, params = {}) {
+  createFileFromUpload(body, params = {}, traceContext) {
     const metadata = {
       method: 'POST',
       endpoint: '/file/upload'
@@ -178,12 +184,13 @@ export class MediaStore {
       },
       params,
       headers: jsonHeaders,
-      body: JSON.stringify(body)
+      body: JSON.stringify(body),
+      traceContext
     };
     return this.request('/file/upload', options).then(createMapResponseToJson(metadata));
   }
 
-  touchFiles(body, params = {}) {
+  touchFiles(body, params = {}, traceContext) {
     const metadata = {
       method: 'POST',
       endpoint: '/upload/createWithFiles'
@@ -193,12 +200,13 @@ export class MediaStore {
         collectionName: params.collection
       },
       headers: jsonHeaders,
-      body: JSON.stringify(body)
+      body: JSON.stringify(body),
+      traceContext
     };
     return this.request('/upload/createWithFiles', options).then(createMapResponseToJson(metadata));
   }
 
-  getFile(fileId, params = {}) {
+  getFile(fileId, params = {}, traceContext) {
     const metadata = {
       method: 'GET',
       endpoint: '/file/{fileId}'
@@ -207,7 +215,8 @@ export class MediaStore {
       authContext: {
         collectionName: params.collection
       },
-      params
+      params,
+      traceContext
     };
     return this.request(`/file/${fileId}`, options).then(createMapResponseToJson(metadata));
   }
@@ -220,7 +229,8 @@ export class MediaStore {
       collectionName
     });
     return this.createFileImageURL(id, auth, params);
-  }
+  } // TODO Create ticket in case Trace Id can be supported through query params
+
 
   getFileImageURLSync(id, params) {
     const auth = this.resolveInitialAuth();
@@ -270,15 +280,13 @@ export class MediaStore {
     return createUrl(`${auth.baseUrl}${artifactUrl}`, options);
   }
 
-  async getImage(id, params, controller, fetchMaxRes) {
+  async getImage(id, params, controller, fetchMaxRes, traceContext) {
     // TODO add checkWebpSupport() back https://product-fabric.atlassian.net/browse/MPT-584
     const isWebpSupported = false;
-    let headers;
+    const headers = {};
 
     if (isWebpSupported) {
-      headers = {
-        accept: 'image/webp,image/*,*/*;q=0.8'
-      };
+      headers.accept = 'image/webp,image/*,*/*;q=0.8';
     }
 
     const metadata = {
@@ -290,12 +298,13 @@ export class MediaStore {
         collectionName: params && params.collection
       },
       params: extendImageParams(params, fetchMaxRes),
-      headers
+      headers,
+      traceContext
     };
     return this.request(`/file/${id}/image`, options, controller).then(createMapResponseToBlob(metadata));
   }
 
-  async getItems(ids, collectionName) {
+  async getItems(ids, collectionName, traceContext) {
     const descriptors = ids.map(id => ({
       type: 'file',
       id,
@@ -312,12 +321,13 @@ export class MediaStore {
       headers: jsonHeaders,
       body: JSON.stringify({
         descriptors
-      })
+      }),
+      traceContext
     };
     return this.request('/items', options).then(createMapResponseToJson(metadata));
   }
 
-  async getImageMetadata(id, params) {
+  async getImageMetadata(id, params, traceContext) {
     const metadata = {
       method: 'GET',
       endpoint: '/file/{fileId}/image/metadata'
@@ -326,12 +336,13 @@ export class MediaStore {
       authContext: {
         collectionName: params && params.collection
       },
-      params
+      params,
+      traceContext
     };
     return this.request(`/file/${id}/image/metadata`, options).then(createMapResponseToJson(metadata));
   }
 
-  async appendChunksToUpload(uploadId, body, collectionName) {
+  async appendChunksToUpload(uploadId, body, collectionName, traceContext) {
     const metadata = {
       method: 'PUT',
       endpoint: '/upload/{uploadId}/chunks'
@@ -341,12 +352,13 @@ export class MediaStore {
         collectionName
       },
       headers: jsonHeaders,
-      body: JSON.stringify(body)
+      body: JSON.stringify(body),
+      traceContext
     };
     await this.request(`/upload/${uploadId}/chunks`, options);
   }
 
-  copyFileWithToken(body, params) {
+  copyFileWithToken(body, params, traceContext) {
     const metadata = {
       method: 'POST',
       endpoint: '/file/copy/withToken'
@@ -359,8 +371,9 @@ export class MediaStore {
       params,
       // Contains collection name to write to
       headers: jsonHeaders,
-      body: JSON.stringify(body) // Contains collection name to read from
-
+      body: JSON.stringify(body),
+      // Contains collection name to read from
+      traceContext
     };
     return this.request('/file/copy/withToken', options).then(createMapResponseToJson(metadata));
   }
@@ -377,9 +390,13 @@ export class MediaStore {
       params,
       headers,
       body,
-      clientOptions
+      clientOptions,
+      traceContext
     } = options;
     const auth = await this.resolveAuth(authContext);
+    const extendedTraceContext = traceContext ? { ...traceContext,
+      spanId: (traceContext === null || traceContext === void 0 ? void 0 : traceContext.spanId) || getRandomHex(16)
+    } : undefined;
     const response = await request(`${auth.baseUrl}${path}`, {
       method,
       endpoint,
@@ -387,7 +404,8 @@ export class MediaStore {
       params,
       headers,
       body,
-      clientOptions
+      clientOptions,
+      traceContext: extendedTraceContext
     }, controller);
     setKeyValueInSessionStorage(MEDIA_API_REGION, response.headers.get('x-media-region'));
     setKeyValueInSessionStorage(MEDIA_API_ENVIRONMENT, response.headers.get('x-media-env'));