@atlaskit/media-client 36.1.1 → 36.2.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/media-client
 
+## 36.2.1
+
+### Patch Changes
+
+- Updated dependencies
+
+## 36.2.0
+
+### Minor Changes
+
+- [`21abd28a7966a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/21abd28a7966a) -
+  Adds x-expected-size header to multipart chunk uploads to prevent corrupted file entries in the
+  object store.
+
 ## 36.1.1
 
 ### Patch Changes

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

@@ -840,8 +840,8 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
   }, {
     key: "appendChunksToUpload",
     value: function () {
-      var _appendChunksToUpload = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee15(uploadId, body, collectionName, traceContext) {
-        var metadata, options;
+      var _appendChunksToUpload = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee15(uploadId, body, collectionName, traceContext, options) {
+        var metadata, headers, requestOptions;
         return _regenerator.default.wrap(function _callee15$(_context15) {
           while (1) switch (_context15.prev = _context15.next) {
             case 0:
@@ -849,23 +849,27 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
                 method: 'PUT',
                 endpoint: '/upload/{uploadId}/chunks'
               };
-              options = _objectSpread(_objectSpread({}, metadata), {}, {
+              headers = _objectSpread({}, jsonHeaders);
+              if ((options === null || options === void 0 ? void 0 : options.expectedFileSize) !== undefined && (0, _platformFeatureFlags.fg)('platform_media_upload_expected_size_header')) {
+                headers['x-expected-size'] = options.expectedFileSize.toString();
+              }
+              requestOptions = _objectSpread(_objectSpread({}, metadata), {}, {
                 authContext: {
                   collectionName: collectionName
                 },
-                headers: jsonHeaders,
+                headers: headers,
                 body: JSON.stringify(body),
                 traceContext: traceContext
               });
-              _context15.next = 4;
-              return this.request("/upload/".concat(uploadId, "/chunks"), options);
-            case 4:
+              _context15.next = 6;
+              return this.request("/upload/".concat(uploadId, "/chunks"), requestOptions);
+            case 6:
             case "end":
               return _context15.stop();
           }
         }, _callee15, this);
       }));
-      function appendChunksToUpload(_x51, _x52, _x53, _x54) {
+      function appendChunksToUpload(_x51, _x52, _x53, _x54, _x55) {
         return _appendChunksToUpload.apply(this, arguments);
       }
       return appendChunksToUpload;
@@ -948,7 +952,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
           }
         }, _callee16, this);
       }));
-      function registerCopyIntents(_x55, _x56, _x57) {
+      function registerCopyIntents(_x56, _x57, _x58) {
         return _registerCopyIntents.apply(this, arguments);
       }
       return registerCopyIntents;
@@ -1036,7 +1040,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
           }
         }, _callee17, this);
       }));
-      function request(_x58) {
+      function request(_x59) {
         return _request2.apply(this, arguments);
       }
       return request;
@@ -1069,7 +1073,7 @@ var MediaStore = exports.MediaStore = /*#__PURE__*/function () {
           }
         }, _callee18);
       }));
-      function testUrl(_x59) {
+      function testUrl(_x60) {
         return _testUrl.apply(this, arguments);
       }
       return testUrl;

package/dist/cjs/uploader/index.js

@@ -68,7 +68,7 @@ var createUploadingFunction = function createUploadingFunction(store, deferredUp
     };
   }();
 };
-var createProcessingFunction = function createProcessingFunction(store, deferredUploadId, collection, traceContext) {
+var createProcessingFunction = function createProcessingFunction(store, deferredUploadId, collection, traceContext, size) {
   var offset = 0;
   return /*#__PURE__*/function () {
     var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(chunks) {
@@ -86,11 +86,14 @@ var createProcessingFunction = function createProcessingFunction(store, deferred
             };
             _context3.t3 = collection;
             _context3.t4 = traceContext;
-            _context3.next = 9;
-            return _context3.t0.appendChunksToUpload.call(_context3.t0, _context3.t1, _context3.t2, _context3.t3, _context3.t4);
-          case 9:
-            offset += chunks.length;
+            _context3.t5 = {
+              expectedFileSize: size
+            };
+            _context3.next = 10;
+            return _context3.t0.appendChunksToUpload.call(_context3.t0, _context3.t1, _context3.t2, _context3.t3, _context3.t4, _context3.t5);
           case 10:
+            offset += chunks.length;
+          case 11:
           case "end":
             return _context3.stop();
         }
@@ -170,7 +173,7 @@ var uploadFile = exports.uploadFile = function uploadFile(file, store, uploadabl
     uploadingConcurrency: 3,
     uploadingFunction: createUploadingFunction(store, deferredUploadId, collection, traceContext),
     processingBatchSize: _constants.PROCESSING_BATCH_SIZE,
-    processingFunction: createProcessingFunction(store, deferredUploadId, collection, traceContext)
+    processingFunction: createProcessingFunction(store, deferredUploadId, collection, traceContext, file.size)
   }, {
     onProgress: function onProgress(progress) {
       if (callbacks) {

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

@@ -523,21 +523,27 @@ export class MediaStore {
     };
     return this.request(`/file/${id}/document/${endpoint}`, requestOptions).then(createMapResponseToBlob(metadata));
   }
-  async appendChunksToUpload(uploadId, body, collectionName, traceContext) {
+  async appendChunksToUpload(uploadId, body, collectionName, traceContext, options) {
     const metadata = {
       method: 'PUT',
       endpoint: '/upload/{uploadId}/chunks'
     };
-    const options = {
+    const headers = {
+      ...jsonHeaders
+    };
+    if ((options === null || options === void 0 ? void 0 : options.expectedFileSize) !== undefined && fg('platform_media_upload_expected_size_header')) {
+      headers['x-expected-size'] = options.expectedFileSize.toString();
+    }
+    const requestOptions = {
       ...metadata,
       authContext: {
         collectionName
       },
-      headers: jsonHeaders,
+      headers,
       body: JSON.stringify(body),
       traceContext
     };
-    await this.request(`/upload/${uploadId}/chunks`, options);
+    await this.request(`/upload/${uploadId}/chunks`, requestOptions);
   }
   copyFileWithToken(body, params, traceContext) {
     const metadata = {

package/dist/es2019/uploader/index.js

@@ -15,13 +15,15 @@ const hashingFunction = async (blob, hashAlgorithm) => {
 const createUploadingFunction = (store, deferredUploadId, collectionName, traceContext) => async chunk => {
   return await store.uploadChunk(chunk.hash, chunk.blob, await deferredUploadId, chunk.partNumber, collectionName, traceContext);
 };
-const createProcessingFunction = (store, deferredUploadId, collection, traceContext) => {
+const createProcessingFunction = (store, deferredUploadId, collection, traceContext, size) => {
   let offset = 0;
   return async chunks => {
     await store.appendChunksToUpload(await deferredUploadId, {
       chunks: hashedChunks(chunks),
       offset
-    }, collection, traceContext);
+    }, collection, traceContext, {
+      expectedFileSize: size
+    });
     offset += chunks.length;
   };
 };
@@ -89,7 +91,7 @@ export const uploadFile = (file, store, uploadableFileUpfrontIds, callbacks, tra
     uploadingConcurrency: 3,
     uploadingFunction: createUploadingFunction(store, deferredUploadId, collection, traceContext),
     processingBatchSize: PROCESSING_BATCH_SIZE,
-    processingFunction: createProcessingFunction(store, deferredUploadId, collection, traceContext)
+    processingFunction: createProcessingFunction(store, deferredUploadId, collection, traceContext, file.size)
   }, {
     onProgress(progress) {
       if (callbacks) {

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

@@ -834,8 +834,8 @@ export var MediaStore = /*#__PURE__*/function () {
   }, {
     key: "appendChunksToUpload",
     value: function () {
-      var _appendChunksToUpload = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee15(uploadId, body, collectionName, traceContext) {
-        var metadata, options;
+      var _appendChunksToUpload = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee15(uploadId, body, collectionName, traceContext, options) {
+        var metadata, headers, requestOptions;
         return _regeneratorRuntime.wrap(function _callee15$(_context15) {
           while (1) switch (_context15.prev = _context15.next) {
             case 0:
@@ -843,23 +843,27 @@ export var MediaStore = /*#__PURE__*/function () {
                 method: 'PUT',
                 endpoint: '/upload/{uploadId}/chunks'
               };
-              options = _objectSpread(_objectSpread({}, metadata), {}, {
+              headers = _objectSpread({}, jsonHeaders);
+              if ((options === null || options === void 0 ? void 0 : options.expectedFileSize) !== undefined && fg('platform_media_upload_expected_size_header')) {
+                headers['x-expected-size'] = options.expectedFileSize.toString();
+              }
+              requestOptions = _objectSpread(_objectSpread({}, metadata), {}, {
                 authContext: {
                   collectionName: collectionName
                 },
-                headers: jsonHeaders,
+                headers: headers,
                 body: JSON.stringify(body),
                 traceContext: traceContext
               });
-              _context15.next = 4;
-              return this.request("/upload/".concat(uploadId, "/chunks"), options);
-            case 4:
+              _context15.next = 6;
+              return this.request("/upload/".concat(uploadId, "/chunks"), requestOptions);
+            case 6:
             case "end":
               return _context15.stop();
           }
         }, _callee15, this);
       }));
-      function appendChunksToUpload(_x51, _x52, _x53, _x54) {
+      function appendChunksToUpload(_x51, _x52, _x53, _x54, _x55) {
         return _appendChunksToUpload.apply(this, arguments);
       }
       return appendChunksToUpload;
@@ -942,7 +946,7 @@ export var MediaStore = /*#__PURE__*/function () {
           }
         }, _callee16, this);
       }));
-      function registerCopyIntents(_x55, _x56, _x57) {
+      function registerCopyIntents(_x56, _x57, _x58) {
         return _registerCopyIntents.apply(this, arguments);
       }
       return registerCopyIntents;
@@ -1030,7 +1034,7 @@ export var MediaStore = /*#__PURE__*/function () {
           }
         }, _callee17, this);
       }));
-      function request(_x58) {
+      function request(_x59) {
         return _request2.apply(this, arguments);
       }
       return request;
@@ -1063,7 +1067,7 @@ export var MediaStore = /*#__PURE__*/function () {
           }
         }, _callee18);
       }));
-      function testUrl(_x59) {
+      function testUrl(_x60) {
         return _testUrl.apply(this, arguments);
       }
       return testUrl;

package/dist/esm/uploader/index.js

@@ -62,7 +62,7 @@ var createUploadingFunction = function createUploadingFunction(store, deferredUp
     };
   }();
 };
-var createProcessingFunction = function createProcessingFunction(store, deferredUploadId, collection, traceContext) {
+var createProcessingFunction = function createProcessingFunction(store, deferredUploadId, collection, traceContext, size) {
   var offset = 0;
   return /*#__PURE__*/function () {
     var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(chunks) {
@@ -80,11 +80,14 @@ var createProcessingFunction = function createProcessingFunction(store, deferred
             };
             _context3.t3 = collection;
             _context3.t4 = traceContext;
-            _context3.next = 9;
-            return _context3.t0.appendChunksToUpload.call(_context3.t0, _context3.t1, _context3.t2, _context3.t3, _context3.t4);
-          case 9:
-            offset += chunks.length;
+            _context3.t5 = {
+              expectedFileSize: size
+            };
+            _context3.next = 10;
+            return _context3.t0.appendChunksToUpload.call(_context3.t0, _context3.t1, _context3.t2, _context3.t3, _context3.t4, _context3.t5);
           case 10:
+            offset += chunks.length;
+          case 11:
           case "end":
             return _context3.stop();
         }
@@ -164,7 +167,7 @@ export var uploadFile = function uploadFile(file, store, uploadableFileUpfrontId
     uploadingConcurrency: 3,
     uploadingFunction: createUploadingFunction(store, deferredUploadId, collection, traceContext),
     processingBatchSize: PROCESSING_BATCH_SIZE,
-    processingFunction: createProcessingFunction(store, deferredUploadId, collection, traceContext)
+    processingFunction: createProcessingFunction(store, deferredUploadId, collection, traceContext, file.size)
   }, {
     onProgress: function onProgress(progress) {
       if (callbacks) {

package/dist/types/client/media-store/MediaStore.d.ts

@@ -35,7 +35,9 @@ export declare class MediaStore implements MediaApi {
     }>;
     getDocumentContent(id: string, options: GetDocumentContentOptions, traceContext?: MediaTraceContext): Promise<DocumentPageRangeContent>;
     getDocumentPageImage(id: string, options: GetDocumentPageImage, traceContext?: MediaTraceContext): Promise<Blob>;
-    appendChunksToUpload(uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
+    appendChunksToUpload(uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext, options?: {
+        expectedFileSize?: number;
+    }): Promise<void>;
     copyFileWithToken(body: MediaStoreCopyFileWithTokenBody, params: MediaStoreCopyFileWithTokenParams, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaFile>>;
     copyFile(id: string, params: CopyFileParams, traceContext?: MediaTraceContext, clientId?: string): Promise<MediaStoreResponse<MediaFile>>;
     registerCopyIntents(files: Array<{

package/dist/types/client/media-store/types.d.ts

@@ -185,7 +185,9 @@ export interface MediaApi {
     getImageMetadata: (id: string, params?: MediaStoreGetFileImageParams, traceContext?: MediaTraceContext) => Promise<{
         metadata: ImageMetadata;
     }>;
-    appendChunksToUpload: (uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext) => Promise<void>;
+    appendChunksToUpload: (uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext, options?: {
+        expectedFileSize?: number;
+    }) => Promise<void>;
     copyFileWithToken: (body: MediaStoreCopyFileWithTokenBody, params: MediaStoreCopyFileWithTokenParams, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaFile>>;
     copyFile: (id: string, params: CopyFileParams) => Promise<MediaStoreResponse<MediaFile>>;
     registerCopyIntents: (files: Array<{

package/dist/types-ts4.5/client/media-store/MediaStore.d.ts

@@ -35,7 +35,9 @@ export declare class MediaStore implements MediaApi {
     }>;
     getDocumentContent(id: string, options: GetDocumentContentOptions, traceContext?: MediaTraceContext): Promise<DocumentPageRangeContent>;
     getDocumentPageImage(id: string, options: GetDocumentPageImage, traceContext?: MediaTraceContext): Promise<Blob>;
-    appendChunksToUpload(uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext): Promise<void>;
+    appendChunksToUpload(uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext, options?: {
+        expectedFileSize?: number;
+    }): Promise<void>;
     copyFileWithToken(body: MediaStoreCopyFileWithTokenBody, params: MediaStoreCopyFileWithTokenParams, traceContext?: MediaTraceContext): Promise<MediaStoreResponse<MediaFile>>;
     copyFile(id: string, params: CopyFileParams, traceContext?: MediaTraceContext, clientId?: string): Promise<MediaStoreResponse<MediaFile>>;
     registerCopyIntents(files: Array<{

package/dist/types-ts4.5/client/media-store/types.d.ts

@@ -185,7 +185,9 @@ export interface MediaApi {
     getImageMetadata: (id: string, params?: MediaStoreGetFileImageParams, traceContext?: MediaTraceContext) => Promise<{
         metadata: ImageMetadata;
     }>;
-    appendChunksToUpload: (uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext) => Promise<void>;
+    appendChunksToUpload: (uploadId: string, body: AppendChunksToUploadRequestBody, collectionName?: string, traceContext?: MediaTraceContext, options?: {
+        expectedFileSize?: number;
+    }) => Promise<void>;
     copyFileWithToken: (body: MediaStoreCopyFileWithTokenBody, params: MediaStoreCopyFileWithTokenParams, traceContext?: MediaTraceContext) => Promise<MediaStoreResponse<MediaFile>>;
     copyFile: (id: string, params: CopyFileParams) => Promise<MediaStoreResponse<MediaFile>>;
     registerCopyIntents: (files: Array<{

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/media-client",
-	"version": "36.1.1",
+	"version": "36.2.1",
 	"description": "Media API Web Client Library",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -29,9 +29,9 @@
 		}
 	},
 	"dependencies": {
-		"@atlaskit/atlassian-context": "^0.8.0",
+		"@atlaskit/atlassian-context": "^0.9.0",
 		"@atlaskit/chunkinator": "^7.1.0",
-		"@atlaskit/media-common": "^13.2.0",
+		"@atlaskit/media-common": "^13.3.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@babel/runtime": "^7.0.0",
 		"dataloader": "^2.1.0",
@@ -54,7 +54,7 @@
 		"@atlaskit/ssr": "workspace:^",
 		"@atlaskit/tokens": "^13.0.0",
 		"@atlassian/a11y-jest-testing": "^0.11.0",
-		"@atlassian/feature-flags-test-utils": "^1.0.0",
+		"@atlassian/feature-flags-test-utils": "^1.1.0",
 		"@emotion/react": "^11.7.1",
 		"@types/deep-equal": "^1.0.1",
 		"fetch-mock": "^8.0.0",
@@ -95,6 +95,9 @@
 		},
 		"confluence_watermark_admin_ui": {
 			"type": "boolean"
+		},
+		"platform_media_upload_expected_size_header": {
+			"type": "boolean"
 		}
 	}
 }