@atlaskit/media-client 18.1.0 → 19.1.0

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, traceId) {
-    return this.mediaStore.getImage(id, params, controller, fetchMaxRes, traceId);
+  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

@@ -32,13 +32,6 @@ const jsonHeaders = {
   Accept: 'application/json',
   'Content-Type': 'application/json'
 };
-export const ZipkinHeaderKeys = {
-  traceId: 'x-b3-traceid',
-  spanId: 'x-b3-spanid',
-  parentSpanId: 'x-b3-parentspanid',
-  sampled: 'x-b3-sampled',
-  flags: 'x-b3-flags'
-};
 export class MediaStore {
   constructor(config, featureFlags) {
     _defineProperty(this, "resolveAuth", authContext => resolveAuth(this.config.authProvider, authContext));
@@ -49,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'
@@ -63,7 +56,8 @@ export class MediaStore {
       },
       headers: {
         Accept: 'application/json'
-      }
+      },
+      traceContext
     };
     const response = await this.request(`/collection/${collectionName}/items`, options);
     const {
@@ -83,7 +77,7 @@ export class MediaStore {
     };
   }
 
-  async removeCollectionFile(id, collectionName, occurrenceKey) {
+  async removeCollectionFile(id, collectionName, occurrenceKey, traceContext) {
     const metadata = {
       method: 'PUT',
       endpoint: '/collection/{collectionName}'
@@ -106,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'
@@ -125,7 +120,8 @@ export class MediaStore {
       },
       headers: {
         Accept: 'application/json'
-      }
+      },
+      traceContext
     };
     return this.request(`/upload`, options).then(createMapResponseToJson(metadata));
   }
@@ -134,7 +130,7 @@ export class MediaStore {
     collectionName,
     uploadId,
     partNumber
-  } = {}) {
+  } = {}, traceContext) {
     const metadata = {
       method: 'PUT',
       endpoint: '/chunk/{etag}'
@@ -147,7 +143,8 @@ export class MediaStore {
       authContext: {
         collectionName
       },
-      body: blob
+      body: blob,
+      traceContext
     };
     await this.request(`/chunk/${etag}`, options);
   }
@@ -155,7 +152,7 @@ export class MediaStore {
   probeChunks(chunks, {
     collectionName,
     uploadId
-  } = {}) {
+  } = {}, traceContext) {
     const metadata = {
       method: 'POST',
       endpoint: '/chunk/probe'
@@ -170,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'
@@ -186,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'
@@ -201,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}'
@@ -215,7 +215,8 @@ export class MediaStore {
       authContext: {
         collectionName: params.collection
       },
-      params
+      params,
+      traceContext
     };
     return this.request(`/file/${fileId}`, options).then(createMapResponseToJson(metadata));
   }
@@ -228,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();
@@ -278,13 +280,10 @@ export class MediaStore {
     return createUrl(`${auth.baseUrl}${artifactUrl}`, options);
   }
 
-  async getImage(id, params, controller, fetchMaxRes, traceId) {
+  async getImage(id, params, controller, fetchMaxRes, traceContext) {
     // TODO add checkWebpSupport() back https://product-fabric.atlassian.net/browse/MPT-584
     const isWebpSupported = false;
-    let headers = !!traceId ? {
-      [ZipkinHeaderKeys.traceId]: traceId,
-      [ZipkinHeaderKeys.spanId]: getRandomHex(16)
-    } : {};
+    const headers = {};
 
     if (isWebpSupported) {
       headers.accept = 'image/webp,image/*,*/*;q=0.8';
@@ -299,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,
@@ -321,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'
@@ -335,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'
@@ -350,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'
@@ -368,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));
   }
@@ -386,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(8)
+    } : undefined;
     const response = await request(`${auth.baseUrl}${path}`, {
       method,
       endpoint,
@@ -396,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'));

package/dist/es2019/models/file-state.js

@@ -25,7 +25,8 @@ export const mapMediaFileToFileState = mediaFile => {
     mediaType,
     mimeType,
     representations,
-    createdAt
+    createdAt,
+    metadataTraceContext
   } = mediaFile.data;
   const baseState = {
     id,
@@ -35,7 +36,8 @@ export const mapMediaFileToFileState = mediaFile => {
     mimeType,
     artifacts,
     representations,
-    createdAt
+    createdAt,
+    metadataTraceContext
   };
 
   switch (processingStatus) {

package/dist/es2019/uploader/index.js

@@ -5,45 +5,41 @@ import { createHasher } from '../utils/hashing/hasherCreator';
 import { UploaderError } from './error';
 import { CHUNK_SIZE, PROCESSING_BATCH_SIZE } from '../constants';
 import { calculateChunkSize, fileSizeError } from './calculateChunkSize';
-import { getMediaFeatureFlag } from '@atlaskit/media-common'; // TODO: Allow to pass multiple files
 
 const hashingFunction = async blob => {
   const hasher = await createHasher();
   return hasher.hash(blob);
 };
 
-const createProbingFunction = (store, deferredUploadId, collectionName) => async chunks => {
+const createProbingFunction = (store, deferredUploadId, collectionName, traceContext) => async chunks => {
   const response = await store.probeChunks(hashedChunks(chunks), {
     collectionName,
-    uploadId: getMediaFeatureFlag('mediaUploadApiV2', store.featureFlags) ? await deferredUploadId : undefined
-  });
+    uploadId: await deferredUploadId
+  }, traceContext);
   const results = response.data.results;
   return Object.values(results).map(result => result.exists);
 };
 
-const createUploadingFunction = (store, deferredUploadId, collectionName) => async chunk => {
-  const options = getMediaFeatureFlag('mediaUploadApiV2', store.featureFlags) ? {
-    partNumber: chunk.partNumber,
-    uploadId: await deferredUploadId
-  } : {};
+const createUploadingFunction = (store, deferredUploadId, collectionName, traceContext) => async chunk => {
   return await store.uploadChunk(chunk.hash, chunk.blob, {
     collectionName,
-    ...options
-  });
+    partNumber: chunk.partNumber,
+    uploadId: await deferredUploadId
+  }, traceContext);
 };
 
-const createProcessingFunction = (store, deferredUploadId, collection) => {
+const createProcessingFunction = (store, deferredUploadId, collection, traceContext) => {
   let offset = 0;
   return async chunks => {
     await store.appendChunksToUpload(await deferredUploadId, {
       chunks: hashedChunks(chunks),
       offset
-    }, collection);
+    }, collection, traceContext);
     offset += chunks.length;
   };
 };
 
-const createFileFromUpload = async (file, store, uploadableFileUpfrontIds, uploadId) => {
+const createFileFromUpload = async (file, store, uploadableFileUpfrontIds, uploadId, traceContext) => {
   const {
     collection,
     name,
@@ -61,10 +57,10 @@ const createFileFromUpload = async (file, store, uploadableFileUpfrontIds, uploa
     occurrenceKey,
     collection,
     replaceFileId: id
-  });
+  }, traceContext);
 };
 
-export const uploadFile = (file, store, uploadableFileUpfrontIds, callbacks) => {
+export const uploadFile = (file, store, uploadableFileUpfrontIds, callbacks, traceContext) => {
   const {
     content,
     collection
@@ -77,7 +73,7 @@ export const uploadFile = (file, store, uploadableFileUpfrontIds, callbacks) =>
   let chunkSize = CHUNK_SIZE;
 
   try {
-    if (content instanceof Blob && getMediaFeatureFlag('mediaUploadApiV2', store.featureFlags)) {
+    if (content instanceof Blob) {
       chunkSize = calculateChunkSize(content.size);
     }
   } catch (err) {
@@ -101,10 +97,10 @@ export const uploadFile = (file, store, uploadableFileUpfrontIds, callbacks) =>
     probingBatchSize: 100,
     chunkSize,
     uploadingConcurrency: 3,
-    uploadingFunction: createUploadingFunction(store, deferredUploadId, collection),
-    probingFunction: createProbingFunction(store, deferredUploadId, collection),
+    uploadingFunction: createUploadingFunction(store, deferredUploadId, collection, traceContext),
+    probingFunction: createProbingFunction(store, deferredUploadId, collection, traceContext),
     processingBatchSize: PROCESSING_BATCH_SIZE,
-    processingFunction: createProcessingFunction(store, deferredUploadId, collection)
+    processingFunction: createProcessingFunction(store, deferredUploadId, collection, traceContext)
   }, {
     onProgress(progress) {
       if (callbacks) {
@@ -116,7 +112,7 @@ export const uploadFile = (file, store, uploadableFileUpfrontIds, callbacks) =>
 
   const onUploadFinish = callbacks && callbacks.onUploadFinish || (() => {});
 
-  const subscription = from(deferredUploadId).pipe(concatMap(uploadId => chunkinatorObservable.pipe(concatMap(() => from(createFileFromUpload(file, store, uploadableFileUpfrontIds, uploadId)))))).subscribe({
+  const subscription = from(deferredUploadId).pipe(concatMap(uploadId => chunkinatorObservable.pipe(concatMap(() => from(createFileFromUpload(file, store, uploadableFileUpfrontIds, uploadId, traceContext)))))).subscribe({
     error: err => onUploadFinish(err),
     complete: () => onUploadFinish()
   });

package/dist/es2019/utils/createFileDataLoader.js

@@ -2,6 +2,7 @@
 // @see https://github.com/graphql/dataloader/issues/249
 import 'setimmediate';
 import Dataloader from 'dataloader';
+import { getRandomHex } from '@atlaskit/media-common';
 export const MAX_BATCH_SIZE = 100;
 
 const isBatchLoadingErrorResult = result => {
@@ -17,7 +18,9 @@ export const getItemsFromKeys = (dataloaderKeys, fileItems) => {
       collection
     } = fileItem;
     const key = makeCacheKey(id, collection);
-    prev[key] = isBatchLoadingErrorResult(fileItem) ? fileItem.error : fileItem.details;
+    prev[key] = isBatchLoadingErrorResult(fileItem) ? fileItem.error : { ...fileItem.details,
+      metadataTraceContext: fileItem.metadataTraceContext
+    };
     return prev;
   }, {});
   return dataloaderKeys.map(dataloaderKey => {
@@ -55,12 +58,19 @@ export function createBatchLoadingFunc(mediaStore) {
     }, {});
     const items = [];
     await Promise.all(Object.keys(fileIdsByCollection).map(async collectionNameKey => {
+      const metadataTraceContext = {
+        traceId: getRandomHex(8),
+        spanId: getRandomHex(8)
+      };
       const fileIds = fileIdsByCollection[collectionNameKey];
       const collectionName = collectionNameKey === nonCollectionName ? undefined : collectionNameKey;
 
       try {
-        const response = await mediaStore.getItems(fileIds, collectionName);
-        items.push(...response.data.items);
+        const response = await mediaStore.getItems(fileIds, collectionName, metadataTraceContext);
+        const itemsWithMetadataTraceContext = response.data.items.map(item => ({ ...item,
+          metadataTraceContext
+        }));
+        items.push(...itemsWithMetadataTraceContext);
       } catch (error) {
         fileIds.forEach(fileId => {
           items.push({

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

@@ -19,7 +19,26 @@ export function isFetchNetworkError(err) {
 export function isRateLimitedError(error) {
   return !!error && isRequestError(error) && error.attributes.statusCode === 429 || !!error && !!error.message && error.message.includes('429');
 }
+export const ZipkinHeaderKeys = {
+  traceId: 'x-b3-traceid',
+  spanId: 'x-b3-spanid',
+  parentSpanId: 'x-b3-parentspanid',
+  sampled: 'x-b3-sampled',
+  flags: 'x-b3-flags'
+};
+
+const mapTraceIdToRequestHeaders = traceContext => {
+  return traceContext ? {
+    [ZipkinHeaderKeys.traceId]: traceContext.traceId,
+    [ZipkinHeaderKeys.spanId]: traceContext.spanId
+  } : {};
+};
+
 export function mapAuthToRequestHeaders(auth) {
+  if (!auth) {
+    return {};
+  }
+
   if (isClientBasedAuth(auth)) {
     return {
       'X-Client-Id': auth.clientId,
@@ -47,15 +66,14 @@ export function createUrl(url, {
   parsedUrl.searchParams.sort();
   return parsedUrl.toString();
 }
-export function withAuth(auth) {
-  return headers => {
-    if (auth) {
-      return { ...(headers || {}),
-        ...mapAuthToRequestHeaders(auth)
-      };
-    }
+export function extendHeaders(headers, auth, traceContext) {
+  if (!auth && !traceContext && !headers) {
+    return undefined;
+  }
 
-    return headers;
+  return { ...(headers !== null && headers !== void 0 ? headers : {}),
+    ...mapAuthToRequestHeaders(auth),
+    ...mapTraceIdToRequestHeaders(traceContext)
   };
 }
 /**

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

@@ -1,6 +1,6 @@
 export { RequestError, isRequestError } from './errors';
 export { isRateLimitedError } from './helpers';
-import { createUrl, fetchRetry, createProcessFetchResponse, withAuth } from './helpers';
+import { createUrl, fetchRetry, createProcessFetchResponse, extendHeaders } from './helpers';
 export async function request(url, options = {}, controller) {
   const {
     method = 'GET',
@@ -9,14 +9,16 @@ export async function request(url, options = {}, controller) {
     params,
     headers,
     body,
-    clientOptions = {}
+    clientOptions = {},
+    traceContext
   } = options;
   const {
     retryOptions
   } = clientOptions;
   const metadata = {
     method,
-    endpoint
+    endpoint,
+    traceContext
   }; // TODO BMPT-918: add client timeout feature behing a FF (using clientOptions.clientTimeout + Promise.race)
 
   const doFetch = () => fetch(createUrl(url, {
@@ -24,7 +26,7 @@ export async function request(url, options = {}, controller) {
   }), {
     method,
     body,
-    headers: withAuth(auth)(headers),
+    headers: extendHeaders(headers, auth, traceContext),
     signal: controller && controller.signal
   }).then(createProcessFetchResponse(metadata));
 

package/dist/es2019/version.json

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

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

@@ -72,7 +72,7 @@ export var CollectionFetcher = /*#__PURE__*/function () {
     }
   }, {
     key: "getItems",
-    value: function getItems(collectionName, params) {
+    value: function getItems(collectionName, params, traceContext) {
       var _this2 = this;
 
       if (!collectionCache[collectionName]) {
@@ -83,7 +83,7 @@ export var CollectionFetcher = /*#__PURE__*/function () {
       var subject = collection.subject;
       this.mediaStore.getCollectionItems(collectionName, _objectSpread(_objectSpread({}, params), {}, {
         details: 'full'
-      })).then(function (items) {
+      }), traceContext).then(function (items) {
         var _items$data = items.data,
             contents = _items$data.contents,
             nextInclusiveStartKey = _items$data.nextInclusiveStartKey;
@@ -103,14 +103,14 @@ export var CollectionFetcher = /*#__PURE__*/function () {
   }, {
     key: "removeFile",
     value: function () {
-      var _removeFile = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(id, collectionName, occurrenceKey) {
+      var _removeFile = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(id, collectionName, occurrenceKey, traceContext) {
         var collection;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) {
             switch (_context.prev = _context.next) {
               case 0:
                 _context.next = 2;
-                return this.mediaStore.removeCollectionFile(id, collectionName, occurrenceKey);
+                return this.mediaStore.removeCollectionFile(id, collectionName, occurrenceKey, traceContext);
 
               case 2:
                 this.removeFromCache(id, collectionName);
@@ -125,7 +125,7 @@ export var CollectionFetcher = /*#__PURE__*/function () {
         }, _callee, this);
       }));
 
-      function removeFile(_x, _x2, _x3) {
+      function removeFile(_x, _x2, _x3, _x4) {
         return _removeFile.apply(this, arguments);
       }
 
@@ -134,7 +134,7 @@ export var CollectionFetcher = /*#__PURE__*/function () {
   }, {
     key: "loadNextPage",
     value: function () {
-      var _loadNextPage = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(collectionName, params) {
+      var _loadNextPage = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(collectionName, params, traceContext) {
         var collection, isLoading, _collectionCache$coll, inclusiveStartKey, currentItems, subject, response, _response$data, contents, nextInclusiveStartKey, newItems, items;
 
         return _regeneratorRuntime.wrap(function _callee2$(_context2) {
@@ -158,7 +158,7 @@ export var CollectionFetcher = /*#__PURE__*/function () {
                 return this.mediaStore.getCollectionItems(collectionName, _objectSpread(_objectSpread({}, params), {}, {
                   inclusiveStartKey: inclusiveStartKey,
                   details: 'full'
-                }));
+                }), traceContext);
 
               case 8:
                 response = _context2.sent;
@@ -182,7 +182,7 @@ export var CollectionFetcher = /*#__PURE__*/function () {
         }, _callee2, this);
       }));
 
-      function loadNextPage(_x4, _x5) {
+      function loadNextPage(_x5, _x6, _x7) {
         return _loadNextPage.apply(this, arguments);
       }