INTERNAL: ACSP-270 Validation Fixes (#57)

iivvaannxx · web-flow · commit 81194d9fb9c3 · 2025-07-18T17:07:15.000+02:00
* refactor: don't include workspace config in errors

* refactor: add hint on workspace config

* chore: fix readme

* refactor: add more hints

* refactor: fix lint issue

* test: fix test issues

* refactor: add unsaved file
diff --git a/README.md b/README.md
@@ -34,8 +34,8 @@ Go to the [Adobe developer console](https://developer.adobe.com/console) portal
   - Adobe I/O Events for Adobe Commerce
   - Adobe Commerce as a Cloud Service.
     - If upgrading from previous versions without Adobe Commerce as a Cloud Service API:
-      - Check ```.env``` to ensure that ```commerce.accs``` scope has been added to OAUTH_SCOPES
-      - Download again workspace configuration as explained below and execute ```run aio app use``` again.
+      - Check `.env` to ensure that `commerce.accs` scope has been added to `OAUTH_SCOPES`
+      - Download again workspace configuration as explained below and execute `aio app use` again.
 - Download the [workspace configuration JSON](https://developer.adobe.com/commerce/extensibility/events/project-setup/#download-the-workspace-configuration-file) file and save it as `workspace.json` in the `./scripts/onboarding/config` starter kit folder because you will use it to configure Adobe IO Events in commerce afterward.
 
 > [!TIP]
diff --git a/scripts/lib/configure-eventing.js b/scripts/lib/configure-eventing.js
@@ -38,7 +38,11 @@ async function main (providerId, instanceId, workspaceConfiguration, environment
       success: true
     }
   } catch (error) {
-    const hints = []
+    const hints = [
+      'Ensure your "onboarding/config/workspace.json" file is up to date',
+      'Did you run `aio app deploy`? Your runtime actions should be deployed before running the onboarding script',
+      'Make sure your authentication environment parameters are correct. Also check the COMMERCE_BASE_URL'
+    ]
 
     if (error?.message?.includes('Response code 404 (Not Found)')) {
       hints.push('Make sure the latest version of the Adobe I/O Events module (see https://developer.adobe.com/commerce/extensibility/events/release-notes/) is installed and enabled in Commerce (see https://developer.adobe.com/commerce/extensibility/events/installation/).')
@@ -50,7 +54,7 @@ async function main (providerId, instanceId, workspaceConfiguration, environment
       'Unexpected error occurred while updating the eventing configuration of the Adobe I/O Events module in Commerce',
       {
         error,
-        config: body.config,
+        config: { ...body.config, workspace_configuration: undefined },
         hints: hints.length > 0 ? hints : undefined
       }
     )
diff --git a/scripts/lib/event-subscribe.js b/scripts/lib/event-subscribe.js
@@ -32,7 +32,9 @@ async function main (eventSpec, environment) {
   } catch (error) {
     let label = 'UNEXPECTED_ERROR'
     let reason = 'Unexpected error occurred while subscribing to an event in the Adobe I/O Events module in Commerce'
-    const hints = []
+    const hints = [
+      'Make sure your authentication environment parameters are correct. Also check the COMMERCE_BASE_URL'
+    ]
 
     if (error?.message?.includes('Response code 400 (Bad Request)')) {
       label = 'MALFORMED_EVENT_SPEC'
diff --git a/scripts/lib/metadata.js b/scripts/lib/metadata.js
@@ -240,10 +240,19 @@ async function main (clientRegistrations, providers, environment, accessToken) {
       result
     }
   } catch (error) {
+    const hints = [
+      'Make sure your authentication environment parameters are correct. Also check the COMMERCE_BASE_URL',
+      'Did you fill IO_CONSUMER_ID, IO_PROJECT_ID and IO_WORKSPACE_ID environment variables with the values in /onboarding/config/workspace.json?'
+    ]
+
     return makeError(
       'UNEXPECTED_ERROR',
       'Unexpected error occurred while adding metadata to provider',
-      { error, provider: currentProvider }
+      {
+        error,
+        provider: currentProvider,
+        hints: hints.length > 0 ? hints : undefined
+      }
     )
   }
 }
diff --git a/scripts/lib/providers.js b/scripts/lib/providers.js
@@ -179,10 +179,19 @@ async function main (clientRegistrations, environment, accessToken) {
     console.log('Process of creating providers done successfully')
     return response
   } catch (error) {
+    const hints = [
+      'Make sure your authentication environment parameters are correct. Also check the COMMERCE_BASE_URL',
+      'Did you fill IO_CONSUMER_ID, IO_PROJECT_ID and IO_WORKSPACE_ID environment variables with the values in /onboarding/config/workspace.json?'
+    ]
+
     return makeError(
       'UNEXPECTED_ERROR',
       'Unexpected error occurred while creating providers',
-      { error, provider: currentProvider }
+      {
+        error,
+        provider: currentProvider,
+        hints: hints.length > 0 ? hints : undefined
+      }
     )
   }
 }
diff --git a/scripts/lib/registrations.js b/scripts/lib/registrations.js
@@ -80,10 +80,18 @@ async function main (clientRegistrations, providers, environment, accessToken) {
       registrations: result
     }
   } catch (error) {
+    const hints = [
+      'Make sure your authentication environment parameters are correct. Also check the COMMERCE_BASE_URL',
+      'Did you fill IO_CONSUMER_ID, IO_PROJECT_ID and IO_WORKSPACE_ID environment variables with the values in /onboarding/config/workspace.json?'
+    ]
+
     return makeError(
       'UNEXPECTED_ERROR',
       'Unexpected error occurred while creating registrations',
-      { error }
+      {
+        error,
+        hints: hints.length > 0 ? hints : undefined
+      }
     )
   }
 }
diff --git a/test/scripts/lib/onboarding.metadata.test.js b/test/scripts/lib/onboarding.metadata.test.js
@@ -163,7 +163,11 @@ describe('Given on-boarding metadata file', () => {
               id: 'COMMERCE_PROVIDER_ID',
               key: 'commerce',
               label: 'Commerce Provider'
-            }
+            },
+            hints: [
+              'Make sure your authentication environment parameters are correct. Also check the COMMERCE_BASE_URL',
+              'Did you fill IO_CONSUMER_ID, IO_PROJECT_ID and IO_WORKSPACE_ID environment variables with the values in /onboarding/config/workspace.json?'
+            ]
           }
         }
       })
diff --git a/test/scripts/lib/onboarding.providers.test.js b/test/scripts/lib/onboarding.providers.test.js
@@ -1108,7 +1108,11 @@ describe('Given On-boarding providers file', () => {
           reason: 'Unexpected error occurred while creating providers',
           payload: {
             error: fakeError,
-            provider: undefined
+            provider: undefined,
+            hints: [
+              'Make sure your authentication environment parameters are correct. Also check the COMMERCE_BASE_URL',
+              'Did you fill IO_CONSUMER_ID, IO_PROJECT_ID and IO_WORKSPACE_ID environment variables with the values in /onboarding/config/workspace.json?'
+            ]
           }
         }
       })
diff --git a/test/scripts/lib/onboarding.registrations.test.js b/test/scripts/lib/onboarding.registrations.test.js
@@ -841,7 +841,11 @@ describe('Given on-boarding registrations file', () => {
           label: 'UNEXPECTED_ERROR',
           reason: 'Unexpected error occurred while creating registrations',
           payload: {
-            error: fakeError
+            error: fakeError,
+            hints: [
+              'Make sure your authentication environment parameters are correct. Also check the COMMERCE_BASE_URL',
+              'Did you fill IO_CONSUMER_ID, IO_PROJECT_ID and IO_WORKSPACE_ID environment variables with the values in /onboarding/config/workspace.json?'
+            ]
           }
         }
       })

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,11 @@ async function main (providerId, instanceId, workspaceConfiguration, environment`
`38`	`38`	`success: true`
`39`	`39`	`}`
`40`	`40`	`} catch (error) {`
`41`		`- const hints = []`
	`41`	`+ const hints = [`
	`42`	`+ 'Ensure your "onboarding/config/workspace.json" file is up to date',`
	`43`	+ 'Did you run `aio app deploy`? Your runtime actions should be deployed before running the onboarding script',
	`44`	`+ 'Make sure your authentication environment parameters are correct. Also check the COMMERCE_BASE_URL'`
	`45`	`+ ]`
`42`	`46`
`43`	`47`	`if (error?.message?.includes('Response code 404 (Not Found)')) {`
`44`	`48`	`hints.push('Make sure the latest version of the Adobe I/O Events module (see https://developer.adobe.com/commerce/extensibility/events/release-notes/) is installed and enabled in Commerce (see https://developer.adobe.com/commerce/extensibility/events/installation/).')`
`@@ -50,7 +54,7 @@ async function main (providerId, instanceId, workspaceConfiguration, environment`
`50`	`54`	`'Unexpected error occurred while updating the eventing configuration of the Adobe I/O Events module in Commerce',`
`51`	`55`	`{`
`52`	`56`	`error,`
`53`		`- config: body.config,`
	`57`	`+ config: { ...body.config, workspace_configuration: undefined },`
`54`	`58`	`hints: hints.length > 0 ? hints : undefined`
`55`	`59`	`}`
`56`	`60`	`)`
Original file line number	Diff line number	Diff line change
`@@ -240,10 +240,19 @@ async function main (clientRegistrations, providers, environment, accessToken) {`
`240`	`240`	`result`
`241`	`241`	`}`
`242`	`242`	`} catch (error) {`
	`243`	`+ const hints = [`
	`244`	`+ 'Make sure your authentication environment parameters are correct. Also check the COMMERCE_BASE_URL',`
	`245`	`+ 'Did you fill IO_CONSUMER_ID, IO_PROJECT_ID and IO_WORKSPACE_ID environment variables with the values in /onboarding/config/workspace.json?'`
	`246`	`+ ]`
	`247`	`+`
`243`	`248`	`return makeError(`
`244`	`249`	`'UNEXPECTED_ERROR',`
`245`	`250`	`'Unexpected error occurred while adding metadata to provider',`
`246`		`- { error, provider: currentProvider }`
	`251`	`+ {`
	`252`	`+ error,`
	`253`	`+ provider: currentProvider,`
	`254`	`+ hints: hints.length > 0 ? hints : undefined`
	`255`	`+ }`
`247`	`256`	`)`
`248`	`257`	`}`
`249`	`258`	`}`
Original file line number	Diff line number	Diff line change
`@@ -80,10 +80,18 @@ async function main (clientRegistrations, providers, environment, accessToken) {`
`80`	`80`	`registrations: result`
`81`	`81`	`}`
`82`	`82`	`} catch (error) {`
	`83`	`+ const hints = [`
	`84`	`+ 'Make sure your authentication environment parameters are correct. Also check the COMMERCE_BASE_URL',`
	`85`	`+ 'Did you fill IO_CONSUMER_ID, IO_PROJECT_ID and IO_WORKSPACE_ID environment variables with the values in /onboarding/config/workspace.json?'`
	`86`	`+ ]`
	`87`	`+`
`83`	`88`	`return makeError(`
`84`	`89`	`'UNEXPECTED_ERROR',`
`85`	`90`	`'Unexpected error occurred while creating registrations',`
`86`		`- { error }`
	`91`	`+ {`
	`92`	`+ error,`
	`93`	`+ hints: hints.length > 0 ? hints : undefined`
	`94`	`+ }`
`87`	`95`	`)`
`88`	`96`	`}`
`89`	`97`	`}`
Original file line number	Diff line number	Diff line change
`@@ -163,7 +163,11 @@ describe('Given on-boarding metadata file', () => {`
`163`	`163`	`id: 'COMMERCE_PROVIDER_ID',`
`164`	`164`	`key: 'commerce',`
`165`	`165`	`label: 'Commerce Provider'`
`166`		`- }`
	`166`	`+ },`
	`167`	`+ hints: [`
	`168`	`+ 'Make sure your authentication environment parameters are correct. Also check the COMMERCE_BASE_URL',`
	`169`	`+ 'Did you fill IO_CONSUMER_ID, IO_PROJECT_ID and IO_WORKSPACE_ID environment variables with the values in /onboarding/config/workspace.json?'`
	`170`	`+ ]`
`167`	`171`	`}`
`168`	`172`	`}`
`169`	`173`	`})`
Original file line number	Diff line number	Diff line change
`@@ -1108,7 +1108,11 @@ describe('Given On-boarding providers file', () => {`
`1108`	`1108`	`reason: 'Unexpected error occurred while creating providers',`
`1109`	`1109`	`payload: {`
`1110`	`1110`	`error: fakeError,`
`1111`		`- provider: undefined`
	`1111`	`+ provider: undefined,`
	`1112`	`+ hints: [`
	`1113`	`+ 'Make sure your authentication environment parameters are correct. Also check the COMMERCE_BASE_URL',`
	`1114`	`+ 'Did you fill IO_CONSUMER_ID, IO_PROJECT_ID and IO_WORKSPACE_ID environment variables with the values in /onboarding/config/workspace.json?'`
	`1115`	`+ ]`
`1112`	`1116`	`}`
`1113`	`1117`	`}`
`1114`	`1118`	`})`
Original file line number	Diff line number	Diff line change
`@@ -841,7 +841,11 @@ describe('Given on-boarding registrations file', () => {`
`841`	`841`	`label: 'UNEXPECTED_ERROR',`
`842`	`842`	`reason: 'Unexpected error occurred while creating registrations',`
`843`	`843`	`payload: {`
`844`		`- error: fakeError`
	`844`	`+ error: fakeError,`
	`845`	`+ hints: [`
	`846`	`+ 'Make sure your authentication environment parameters are correct. Also check the COMMERCE_BASE_URL',`
	`847`	`+ 'Did you fill IO_CONSUMER_ID, IO_PROJECT_ID and IO_WORKSPACE_ID environment variables with the values in /onboarding/config/workspace.json?'`
	`848`	`+ ]`
`845`	`849`	`}`
`846`	`850`	`}`
`847`	`851`	`})`