CEXT-5328: Add business config lib by aminakhyat · Pull Request #83 · adobe/commerce-integration-starter-kit

aminakhyat · 2025-11-10T15:00:38Z

Description

Add Business Config Library into the Integration Starter Kit.

This PR updates the environment variable naming convention throughout the codebase to use the new AIO_COMMERCE_* prefixes. While most files contain variable name updates, the primary focus of this PR is the integration of aio-commerce-lib-config.

📋 Environment Variable Changes
IMS OAuth Variables:

OAUTH_CLIENT_ID → AIO_COMMERCE_AUTH_IMS_CLIENT_ID
OAUTH_CLIENT_SECRET → AIO_COMMERCE_AUTH_IMS_CLIENT_SECRETS
OAUTH_TECHNICAL_ACCOUNT_ID → AIO_COMMERCE_AUTH_IMS_TECHNICAL_ACCOUNT_ID
OAUTH_TECHNICAL_ACCOUNT_EMAIL → AIO_COMMERCE_AUTH_IMS_TECHNICAL_ACCOUNT_EMAIL
OAUTH_ORG_ID → AIO_COMMERCE_AUTH_IMS_ORG_ID
OAUTH_SCOPES → AIO_COMMERCE_AUTH_IMS_SCOPES

Commerce Integration Variables:

COMMERCE_CONSUMER_KEY → AIO_COMMERCE_AUTH_INTEGRATION_CONSUMER_KEY
COMMERCE_CONSUMER_SECRET → AIO_COMMERCE_AUTH_INTEGRATION_CONSUMER_SECRET
COMMERCE_ACCESS_TOKEN → AIO_COMMERCE_AUTH_INTEGRATION_ACCESS_TOKEN
COMMERCE_ACCESS_TOKEN_SECRET → AIO_COMMERCE_AUTH_INTEGRATION_ACCESS_TOKEN_SECRET
COMMERCE_BASE_URL → AIO_COMMERCE_API_BASE_URL

🎯 Key Files to Review (aio-commerce-lib-config integration)

⚠️ These files contain the most important changes and should be prioritized during review:

commerce-configuration-1/ext.config.yaml - Extension configuration added
app.config.yaml - Application configuration changes to add extension point
env.dist - Environment template with updated variable names
install.yaml - Installation configuration updates
package.json - New dependency additions and updates

rojoangel · 2025-11-11T10:56:09Z

Heads-up: the vars renaming is going to require changes to the starter kit public docs: https://developer.adobe.com/commerce/extensibility/starter-kit/integration/create-integration/, for example the section in the screenshot below

rojoangel · 2025-11-11T11:35:24Z

Following the README to install a vanilla starter-kit project, I run into an issue where the generated runtime actions do not get deployed.
I run directly aio app deploy (didn't call aio app build beforehand), and as the output shows, the config actions are generated after the existing actions have been deployed.

❯ aio app deploy
✔ Built 35 action(s) for 'application'
ℹ No frontend or a build already exists, skipping frontend build for 'application'
✔ Deployed 38 action(s) for 'application'
no frontend, skipping frontend deploy 'application'
Your deployed actions:
web actions:
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/web/starter-kit/info
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/web/webhook/check-stock
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/web/product-commerce/full-sync
non-web actions:
  -> starter-kit/__secured_info
  -> webhook/__secured_check-stock
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/product-commerce/consumer
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/product-commerce/created
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/product-commerce/updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/product-commerce/deleted
  -> product-commerce/__secured_full-sync
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/product-backoffice/consumer
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/product-backoffice/created
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/product-backoffice/updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/product-backoffice/deleted
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-commerce/consumer
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-commerce/created
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-commerce/updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-commerce/deleted
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-commerce/group-updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-commerce/group-deleted
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-backoffice/consumer
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-backoffice/created
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-backoffice/updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-backoffice/deleted
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-backoffice/group-created
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-backoffice/group-updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-backoffice/group-deleted
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/order-commerce/consumer
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/order-commerce/created
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/order-commerce/updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/order-backoffice/consumer
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/order-backoffice/updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/order-backoffice/shipment-created
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/order-backoffice/shipment-updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/stock-commerce/consumer
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/stock-commerce/updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/stock-backoffice/consumer
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/stock-backoffice/updated
2025-11-11T11:29:17.343Z [@adobe/aio-commerce-lib-config:schema-validation] info: 🔄 Analyzing configuration schema...
2025-11-11T11:29:17.346Z [@adobe/aio-commerce-lib-config:schema-validation] info: ✅ Configuration schema validation passed.

2025-11-11T11:29:17.347Z [@adobe/aio-commerce-lib-config:actions:generate] info: 📄 Generated configuration-schema.json

2025-11-11T11:29:17.347Z [@adobe/aio-commerce-lib-config:actions:generate] info: 📝 Updating ext.config.yaml...
2025-11-11T11:29:17.353Z [@adobe/aio-commerce-lib-config:actions:generate] info: 🔧 Generating runtime actions...
2025-11-11T11:29:17.355Z [@adobe/aio-commerce-lib-config:actions:generate] info: ✅ Generated 6 action(s) in .generated/actions/app-management

ℹ no backend, skipping action build for 'commerce/configuration/1'
ℹ No frontend or a build already exists, skipping frontend build for 'commerce/configuration/1'
no backend, skipping action deploy 'commerce/configuration/1'
no frontend, skipping frontend deploy 'commerce/configuration/1'
 ›   Error: Cannot convert undefined or null to object

rojoangel · 2025-11-11T11:37:13Z

Also, notice this error at the end of aio app deploy

›   Error: Cannot convert undefined or null to object

rojoangel · 2025-11-11T11:40:13Z

Is there a recommendation for what to do with the files that were modified during the process? I noticed that they appear as code modified when running git status

❯ git status
Alias tip: gst
On branch CEXT-5328-add-business-config-lib
Your branch is up to date with 'origin/CEXT-5328-add-business-config-lib'.

Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
        modified:   commerce-configuration-1/ext.config.yaml

Untracked files:
  (use "git add <file>..." to include in what will be committed)
        commerce-configuration-1/.generated/

no changes added to commit (use "git add" and/or "git commit -a")

aminakhyat · 2025-11-11T13:12:37Z

Following the README to install a vanilla starter-kit project, I run into an issue where the generated runtime actions do not get deployed. I run directly aio app deploy (didn't call aio app build beforehand), and as the output shows, the config actions are generated after the existing actions have been deployed.

❯ aio app deploy
✔ Built 35 action(s) for 'application'
ℹ No frontend or a build already exists, skipping frontend build for 'application'
✔ Deployed 38 action(s) for 'application'
no frontend, skipping frontend deploy 'application'
Your deployed actions:
web actions:
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/web/starter-kit/info
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/web/webhook/check-stock
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/web/product-commerce/full-sync
non-web actions:
  -> starter-kit/__secured_info
  -> webhook/__secured_check-stock
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/product-commerce/consumer
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/product-commerce/created
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/product-commerce/updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/product-commerce/deleted
  -> product-commerce/__secured_full-sync
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/product-backoffice/consumer
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/product-backoffice/created
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/product-backoffice/updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/product-backoffice/deleted
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-commerce/consumer
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-commerce/created
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-commerce/updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-commerce/deleted
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-commerce/group-updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-commerce/group-deleted
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-backoffice/consumer
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-backoffice/created
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-backoffice/updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-backoffice/deleted
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-backoffice/group-created
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-backoffice/group-updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/customer-backoffice/group-deleted
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/order-commerce/consumer
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/order-commerce/created
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/order-commerce/updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/order-backoffice/consumer
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/order-backoffice/updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/order-backoffice/shipment-created
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/order-backoffice/shipment-updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/stock-commerce/consumer
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/stock-commerce/updated
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/stock-backoffice/consumer
  -> https://3117813-rojopocs-configlibtest2.adobeioruntime.net/api/v1/stock-backoffice/updated
2025-11-11T11:29:17.343Z [@adobe/aio-commerce-lib-config:schema-validation] info: 🔄 Analyzing configuration schema...
2025-11-11T11:29:17.346Z [@adobe/aio-commerce-lib-config:schema-validation] info: ✅ Configuration schema validation passed.

2025-11-11T11:29:17.347Z [@adobe/aio-commerce-lib-config:actions:generate] info: 📄 Generated configuration-schema.json

2025-11-11T11:29:17.347Z [@adobe/aio-commerce-lib-config:actions:generate] info: 📝 Updating ext.config.yaml...
2025-11-11T11:29:17.353Z [@adobe/aio-commerce-lib-config:actions:generate] info: 🔧 Generating runtime actions...
2025-11-11T11:29:17.355Z [@adobe/aio-commerce-lib-config:actions:generate] info: ✅ Generated 6 action(s) in .generated/actions/app-management

ℹ no backend, skipping action build for 'commerce/configuration/1'
ℹ No frontend or a build already exists, skipping frontend build for 'commerce/configuration/1'
no backend, skipping action deploy 'commerce/configuration/1'
no frontend, skipping frontend deploy 'commerce/configuration/1'
 ›   Error: Cannot convert undefined or null to object

I was testing with another app and had no issues, but I see this with SK 🤔 We might need to move the pre-app-build hook up from extensions to application:

application:
  hooks:
    pre-app-build: node_modules/@adobe/aio-commerce-lib-config/dist/cjs/hooks/pre-app-build.cjs

iivvaannxx · 2025-11-13T15:29:34Z

Also, notice this error at the end of aio app deploy

Can reproduce, looking for a fix. This only happens if you run the deploy alongside a build via aio app deploy --force-build, plus the initial content of the ext.config.yaml is {}. If you run the command with the contents that are added by the pre-app-build hook it doesn't happen (even if you delete the built actions or the .generated source code).

Moving the hooks to the application doesn't work, the issue is most likely the one described in this thread. Also, if we were to move the hook this would cause a command like this to fail: aio app deploy --force-build -e commerce/configuration/1, as we would only be targeting a build/deploy for our extension point, and the hook would not be executed.

….com

rojoangel · 2025-11-18T15:29:52Z

The app-management/sync-commerce-scopes action seems to be broken when connected to a SaaS instance. When called, despite the AIO_COMMERCE_AUTH_IMS env vars being initialized, it returns the following error

{
  "code": "INTERNAL_ERROR",
  "details": "Can't resolve authentication options for the given params. Please provide either IMS options (AIO_COMMERCE_AUTH_IMS_CLIENT_ID, AIO_COMMERCE_AUTH_IMS_CLIENT_SECRETS, AIO_COMMERCE_AUTH_IMS_TECHNICAL_ACCOUNT_ID, AIO_COMMERCE_AUTH_IMS_TECHNICAL_ACCOUNT_EMAIL, AIO_COMMERCE_AUTH_IMS_ORG_ID, AIO_COMMERCE_AUTH_IMS_SCOPES) or Commerce integration options (AIO_COMMERCE_AUTH_INTEGRATION_CONSUMER_KEY, AIO_COMMERCE_AUTH_INTEGRATION_CONSUMER_SECRET, AIO_COMMERCE_AUTH_INTEGRATION_ACCESS_TOKEN, AIO_COMMERCE_AUTH_INTEGRATION_ACCESS_TOKEN_SECRET).",
  "message": "An internal server error occurred"
}

For PaaS, it is working fine. though

iivvaannxx · 2025-11-24T17:57:13Z

@rojoangel Everything should be working properly now

aminakhyat marked this pull request as ready for review November 11, 2025 09:34

aminakhyat requested a review from a team as a code owner November 11, 2025 09:34

emartinpalomas approved these changes Nov 11, 2025

View reviewed changes

rojoangel added do-not-merge and removed do-not-merge labels Nov 12, 2025

aminakhyat and others added 13 commits November 17, 2025 16:35

Add aio-commerce-lib-config to ISK

822ea7d

Move ext.config.yaml inside extensions/commerce-configuration-1

73bceae

Move ext.config.yaml inside commerce-configuration-1

72ae2de

Update auth env variable names

88e1cd9

Update lib-config version

a554100

Update versions

00a4614

Parse arrays and update env variable

86d9b84

regenerate package-lock.json to remove refs to artifactory.corp.adobe…

8fa4cef

….com

change only references to artifactory

9310c7b

chore: update lib-auth

7a0fa56

chore: replace with sdk and update lib-config

8fc069d

refactor: use lib-auth from sdk to avoid version conflicts

2eab820

feat: integrate lib config after update

a540aa4

iivvaannxx force-pushed the CEXT-5328-add-business-config-lib branch from 5ee2e81 to a540aa4 Compare November 17, 2025 17:14

iivvaannxx added 2 commits November 17, 2025 19:45

test: fix failing tests

2e02aca

refactor: filter empty secrets to have similar behavior as pre-refactor

5a27c48

iivvaannxx changed the base branch from main to business-config-do-not-delete November 17, 2025 18:53

refactor: regenerate via init script

f9e116c

iivvaannxx added 5 commits November 25, 2025 10:30

docs: document business config

461a80b

docs: add newline in readme

fcaf51a

docs: add link to ext config

8b5278b

docs: remove dup word

4f4c496

docs: improve statement

7fd97e6

iivvaannxx merged commit 421e2f5 into business-config-do-not-delete Nov 25, 2025
2 checks passed

iivvaannxx deleted the CEXT-5328-add-business-config-lib branch November 25, 2025 09:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

CEXT-5328: Add business config lib#83

CEXT-5328: Add business config lib#83
iivvaannxx merged 21 commits intobusiness-config-do-not-deletefrom
CEXT-5328-add-business-config-lib

aminakhyat commented Nov 10, 2025 •

edited

Loading

Uh oh!

rojoangel commented Nov 11, 2025

Uh oh!

rojoangel commented Nov 11, 2025

Uh oh!

rojoangel commented Nov 11, 2025

Uh oh!

rojoangel commented Nov 11, 2025

Uh oh!

aminakhyat commented Nov 11, 2025

Uh oh!

iivvaannxx commented Nov 13, 2025 •

edited

Loading

Uh oh!

rojoangel commented Nov 18, 2025

Uh oh!

iivvaannxx commented Nov 24, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Comments

Conversation

aminakhyat commented Nov 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

rojoangel commented Nov 11, 2025

Uh oh!

rojoangel commented Nov 11, 2025

Uh oh!

rojoangel commented Nov 11, 2025

Uh oh!

rojoangel commented Nov 11, 2025

Uh oh!

aminakhyat commented Nov 11, 2025

Uh oh!

iivvaannxx commented Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rojoangel commented Nov 18, 2025

Uh oh!

iivvaannxx commented Nov 24, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

aminakhyat commented Nov 10, 2025 •

edited

Loading

iivvaannxx commented Nov 13, 2025 •

edited

Loading