IT34677: APPLICATION METADATA CONTAINING COMMAS MIGHT CAUSE IBM DATAPOWER TO RESTART UNEXPECTEDLY

Fix packs for DataPower Gateway version 2018.4.1

APAR status

• Closed as program error.

Error description

• DataPower may may restart unexpectedly if API Connect sends a
  snapshot payload for an application containing commas in its
  metadata json object.
  For example the application payload below, migrated from API
  Connect v5.0.x and containing commas in the "v5_created_by"
  and "v5_updated_by" values of the metadata json object, will
  cause the reload of DataPower.
  ====
  {
  "type": "app",
  "api_version": "2.0.0",
  "id": "398a8a69-ced3-43d7-9132-d86fed408519",
  "name": "test-app-dc91",
  "title": "TestAPP",
  "state": "enabled",
  "lifecycle_state": "production",
  "app_credential_urls": [
  "https://{{hostname-endpoint}}api/apps/1824456a-f483-4782-85b7-5
  08694bdae06/916cab2b-9bb6-4ff0-9bcf-66dba019f8fd/61946ba3-eaab-4
  8a6-8e27-216edc578511/398a8a69-ced3-43d7-9132-d86fed408519/crede
  ntials/a80cbea1-6add-429a-955f-f0c527b69ac4"
  ],
  "redirect_endpoints": [
  "https://example.com/redirect"
  ],
  "metadata": {
  "v5_id": "5f5b352ae4b07921e492d6bd",
  "v5_created_at": "2020-09-11 08:28:26.585 +0000 UTC",
  "v5_created_by": "user1, IBM",
  "v5_updated_at": "2020-09-11 08:28:26.585 +0000 UTC",
  "v5_updated_by": "user1,  IBM"
  },
  "created_at": "2020-10-23T10:58:28.000Z",
  "updated_at": "2020-10-23T13:52:12.000Z",
  "org_url":
  "https://{{hostname-endpoint}}api/orgs/1824456a-f483-4782-85b7-5
  08694bdae06",
  "catalog_url":
  "https://{{hostname-endpoint}}api/catalogs/1824456a-f483-4782-85
  b7-508694bdae06/916cab2b-9bb6-4ff0-9bcf-66dba019f8fd",
  "consumer_org_url":
  "https://{{hostname-endpoint}}api/consumer-orgs/1824456a-f483-47
  82-85b7-508694bdae06/916cab2b-9bb6-4ff0-9bcf-66dba019f8fd/61946b
  a3-eaab-48a6-8e27-216edc578511",
  "url":
  "https://{{hostname-endpoint}}api/apps/1824456a-f483-4782-85b7-5
  08694bdae06/916cab2b-9bb6-4ff0-9bcf-66dba019f8fd/61946ba3-eaab-4
  8a6-8e27-216edc578511/398a8a69-ced3-43d7-9132-d86fed408519"
  }
  ====
  

Local fix

• You can use one of the 3 options below:
  1- Update the v5 definition of the application data directly in
  cloud/provider-orgs/{{org-name}}/catalogs/{{catalog-name}}/consu
  m er-orgs/{{corg-name}}/apps/test-app-dc91/app.yml
  api_version: 2.0.0
  lifecycle_state: production
  metadata:
   v5_created_at: 2020-09-11 08:28:26.585 +0000 UTC
   v5_created_by: user1 IBM
   v5_id: 5f5b352ae4b07921e492d6bd
   v5_updated_at: 2020-09-11 08:28:26.585 +0000 UTC
   v5_updated_by: user1 IBM
  name: test-app-dc91
  state: enabled
  title: TestAP
  type: app
  2- Update application using the REST API:
  curl -L -X PATCH
  'https://{apim-endpoint}/api/apps/{porg-name}/{cat-name}/{corg-n
  ame}/test-app-dc91' \
  -H 'Authorization: Bearer <token>'
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{
      "type": "app",
      "api_version": "2.0.0",
      "metadata": {
          "v5_id": "5f5b352ae4b07921e492d6bd",
          "v5_created_at": "2020-09-11 08:28:26.585 +0000 UTC",
          "v5_created_by": "user1 IBM",
          "v5_updated_at": "2020-09-11 08:28:26.585 +0000 UTC",
          "v5_updated_by": "user1 IBM"
  }
  }'
  3- Update application using the API Connect Toolkit CLI:
  ./apic apps:update test-app-dc91 -s {apim-endpoint} -o
  {porg-name} -c {cat-name} --consumer-org {corg-name}
  app-update.json
  where the app-update.json contains the following content:
  {
      "type": "app",
      "api_version": "2.0.0",
      "metadata": {
        "v5_id": "5f5b352ae4b07921e492d6bd",
          "v5_created_at": "2020-09-11 08:28:26.585 +0000 UTC",
          "v5_created_by": "user1 IBM",
          "v5_updated_at": "2020-09-11 08:28:26.585 +0000 UTC",
          "v5_updated_by": "user1 IBM"
  }
  }
  

Problem summary

• DataPower might restart unexpectedly if API Connect sends a
  snapshot payload for an application containing commas in its
  metadata JSON object.
  

Problem conclusion

• Fix is available in 2018.4.1.16 and 10.0.1.2
  
  For a list of the latest fix packs available, please see:
  https://www.ibm.com/support/pages/node/83105
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

• Fixed component name

  DATAPOWER

• Fixed component ID

  DP1234567

Applicable component levels

• R18X PSY

     UP

• RA0X PSY

     UP