fix: SITES-25634 [Importer] Expose hasCustomImportJs and hasCustomHeaders as two new fields on a import job (#509)

Co-authored-by: Ben Helleman <bhellema@adobe.com>

Author: bhellema

package-lock.json

@@ -66,7 +66,7 @@
     "@adobe/helix-shared-wrap": "2.0.2",
     "@adobe/helix-status": "10.1.3",
     "@adobe/helix-universal-logger": "3.0.20",
-    "@adobe/spacecat-shared-data-access": "1.44.5",
+    "@adobe/spacecat-shared-data-access": "1.45.1",
     "@adobe/spacecat-shared-http-utils": "1.6.10",
     "@adobe/spacecat-shared-ims-client": "1.3.16",
     "@adobe/spacecat-shared-rum-api-client": "2.9.4",

package.json

@@ -30,5 +30,7 @@ export const ImportJobDto = {
     successCount: importJob.getSuccessCount(),
     failedCount: importJob.getFailedCount(),
     redirectCount: importJob.getFailedCount(),
+    hasCustomHeaders: importJob.hasCustomHeaders(),
+    hasCustomImportJs: importJob.hasCustomImportJs(),
   }),
 };

src/dto/import-job.js

@@ -94,10 +94,20 @@ function ImportSupervisor(services, config) {
    * @param {string} hashedApiKey - API key used to authenticate the import job request.
    * @param {object} options - Client provided options for the import job.
    * @param initiatedBy - Details about the initiator of the import job.
+   * @param {boolean} hasCustomHeaders - Whether custom headers are provided. Defaults to false.
+   * @param {boolean} hasCustomImportJs - Whether custom import JS is provided. Defaults to false.
    * @returns {Promise<ImportJob>}
    */
-  async function createNewImportJob(urls, importQueueId, hashedApiKey, options, initiatedBy) {
-    const newJob = {
+  async function createNewImportJob(
+    urls,
+    importQueueId,
+    hashedApiKey,
+    options,
+    initiatedBy,
+    hasCustomHeaders = false,
+    hasCustomImportJs = false,
+  ) {
+    return dataAccess.createNewImportJob({
       id: crypto.randomUUID(),
       baseURL: determineBaseURL(urls),
       importQueueId,
@@ -106,8 +116,9 @@ function ImportSupervisor(services, config) {
       urlCount: urls.length,
       status: ImportJobStatus.RUNNING,
       initiatedBy,
-    };
-    return dataAccess.createNewImportJob(newJob);
+      hasCustomHeaders,
+      hasCustomImportJs,
+    });
   }
 
   /**
@@ -126,6 +137,7 @@ function ImportSupervisor(services, config) {
    * asynchronously.
    * @param {Array<string>} urls - Array of URL records to queue.
    * @param {object} importJob - The import job record.
+   * @param {object} customHeaders - Optional custom headers to be sent with each request.
    */
   async function queueUrlsForImportWorker(urls, importJob, customHeaders) {
     log.info(`Starting a new import job of baseUrl: ${importJob.getBaseURL()} with ${urls.length}`
@@ -159,8 +171,8 @@ function ImportSupervisor(services, config) {
    * @param {string} importApiKey - The API key to use for the import job.
    * @param {object} options - Optional configuration params for the import job.
    * @param {string} importScript - Optional custom Base64 encoded import script.
-   * @param initiatedBy - Details about the initiator of the import job.
-   * @param customHeaders - Optional custom headers to be sent with each request.
+   * @param {object} initiatedBy - Details about the initiator of the import job.
+   * @param {object} customHeaders - Optional custom headers to be sent with each request.
    * @returns {Promise<ImportJob>}
    */
   async function startNewJob(
@@ -184,6 +196,8 @@ function ImportSupervisor(services, config) {
       hashedApiKey,
       options,
       initiatedBy,
+      !!customHeaders,
+      !!importScript,
     );
 
     log.info('New import job created:\n'