Companion option uploadHeaders

[mifi]

closes #5921

also improve tests that currently depend on eachother

todo

• docs Document companion uploadHeaders uppy.io#394

[changeset-bot]

🦋 Changeset detected

Latest commit: 2cd02ac

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@uppy/companion	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

Diff output files

diff --git a/packages/@uppy/companion/lib/server/Uploader.d.ts b/packages/@uppy/companion/lib/server/Uploader.d.ts
index 8c222eb..825d14f 100644
--- a/packages/@uppy/companion/lib/server/Uploader.d.ts
+++ b/packages/@uppy/companion/lib/server/Uploader.d.ts
@@ -52,9 +52,9 @@ declare class Uploader {
      * @property {number} [chunkSize]
      * @property {string} [providerName]
      *
-     * @param {UploaderOptions} options
+     * @param {UploaderOptions} optionsIn
      */
-    constructor(options: {
+    constructor(optionsIn: {
         endpoint: string;
         uploadUrl?: string;
         protocol: string;
@@ -75,6 +75,7 @@ declare class Uploader {
     storage: import("ioredis").Redis;
     providerName: string;
     options: {
+        headers: any;
         endpoint: string;
         uploadUrl?: string;
         protocol: string;
@@ -85,7 +86,6 @@ declare class Uploader {
         metadata: any;
         companionOptions: any;
         storage?: any;
-        headers?: any;
         httpMethod?: string;
         useFormData?: boolean;
         chunkSize?: number;
diff --git a/packages/@uppy/companion/lib/server/Uploader.js b/packages/@uppy/companion/lib/server/Uploader.js
index 310c2ba..966a17c 100644
--- a/packages/@uppy/companion/lib/server/Uploader.js
+++ b/packages/@uppy/companion/lib/server/Uploader.js
@@ -122,10 +122,17 @@ export default class Uploader {
    * @property {number} [chunkSize]
    * @property {string} [providerName]
    *
-   * @param {UploaderOptions} options
+   * @param {UploaderOptions} optionsIn
    */
-  constructor(options) {
-    validateOptions(options);
+  constructor(optionsIn) {
+    validateOptions(optionsIn);
+    const options = {
+      ...optionsIn,
+      headers: {
+        ...optionsIn.headers,
+        ...optionsIn.companionOptions.uploadHeaders,
+      },
+    };
     this.providerName = options.providerName;
     this.options = options;
     this.token = randomUUID();
@@ -547,7 +554,7 @@ export default class Uploader {
     }
     try {
       const httpMethod = (this.options.httpMethod || "").toUpperCase() === "PUT" ? "put" : "post";
-      const runRequest = await got[httpMethod];
+      const runRequest = got[httpMethod];
       const response = await runRequest(url, reqOptions);
       if (this.size != null && bytesUploaded !== this.size) {
         const errMsg = `uploaded only ${bytesUploaded} of ${this.size} with status: ${response.statusCode}`;
diff --git a/packages/@uppy/companion/lib/standalone/helper.js b/packages/@uppy/companion/lib/standalone/helper.js
index a5f931f..fbba5f2 100644
--- a/packages/@uppy/companion/lib/standalone/helper.js
+++ b/packages/@uppy/companion/lib/standalone/helper.js
@@ -195,6 +195,9 @@ const getConfigFromEnv = () => {
     corsOrigins: getCorsOrigins(),
     testDynamicOauthCredentials: process.env.COMPANION_TEST_DYNAMIC_OAUTH_CREDENTIALS === "true",
     testDynamicOauthCredentialsSecret: process.env.COMPANION_TEST_DYNAMIC_OAUTH_CREDENTIALS_SECRET,
+    uploadHeaders: process.env.COMPANION_UPLOAD_HEADERS
+      ? JSON.parse(process.env.COMPANION_UPLOAD_HEADERS)
+      : undefined,
   };
 };
 /**

[Murderlon]

Don't forget the changeset, ideally also explaining there what this feature does