See #89 (via adobe/aio-lib-core-networking#14)

The function campaignStandardCoreAPI.getMetadataForResourceExt("profile") is returning profile-data rather than profile-metadata. from reading the docs I'd assume that this would return the metadata including custom objects (fields, filters, etc).

Is this correct behavior?

I'm on 2.1.3 (latest)

npm audit issue: https://github.com/swagger-api/swagger-js/releases/tag/v3.13.5

See errors here - https://github.com/adobe/aio-e2e-tests/actions/runs/594925640

Expected Behaviour

Actual Behaviour

Reproduce Scenario (including but not limited to)

Steps to Reproduce

Platform and Version

Sample Code that illustrates the problem

Logs taken while reproducing problem

The privateRequestDataUrl is an absolute URL, not a relative one like the previous (incorrect) docs showed. The REST API docs has since been corrected to show that this url is an absolute one.

While using the Campaign Standard libraries, using sendTransactionalEvent(eventId, eventBody) does not identify the transactional event.

Expected Behaviour

sendTransactionalEvent(eventId, eventBody) library method should trigger the transactional event in Adobe Campaign Standard, resulting in message sent to target.

Actual Behaviour

sendTransactionalEvent(eventId, eventBody) library method fails to recognise the transactional event defined in Adobe Campaign Standard.

Reproduce Scenario (including but not limited to)

Steps to Reproduce

Define transactional event and related message (Email) for the event and publish.
Click on the "API preview" to fetch eventId.
For example, the transactional event published in one of the instance https://mc.adobe.io/<ORGANIZATION>/campaign/mcadobedemoinstance/EVT_Order_Approval

Nodesjs:

const acs = require('@adobe/aio-lib-campaign-standard');
const TENANT = "...";
const CLIENT_ID = "...";
const TOKEN = "...";
let payload = {"ctx":{"managerEmail": "[email protected]",...}};
let eventName = "EVT_Order_Approval"
let send_mc_message = async function (tenant, client_id, token, eventName, payload) {
    let acs_instance = await acs.init(tenant, client_id, token);
    return await acs_instance.sendTransactionalEvent(eventName, payload);
};

Error message:

{ CampaignStandardSDKError: [CampaignStandardSDK:ERROR_SEND_TRANSACTIONAL_EVENT] 404 - Not Found ("RST-360011 An error has occurred - please contact your administrator. Error rc=-2003")
    at new <anonymous> (/Users/diptimanbadajena/Documents/Assignments/2020-21/Accelerators/AIO-CNA/cna-app3/node_modules/@adobe/aio-lib-core-errors/src/AioCoreSDKErrorWrapper.js:33:9)
    at sdk.apis.messaging.sendTransactionalEvent.then.catch.err (/Users/diptimanbadajena/Documents/Assignments/2020-21/Accelerators/AIO-CNA/cna-app3/node_modules/@adobe/aio-lib-campaign-standard/src/index.js:428:18)
    at process._tickCallback (internal/process/next_tick.js:68:7)
  code: 'ERROR_SEND_TRANSACTIONAL_EVENT',
  sdk: 'CampaignStandardSDK',
  sdkDetails:
   { eventId: 'EVT_DMKT_Order_Approval',
     eventBody: { ctx: [Object] } },
  name: 'CampaignStandardSDKError' }

Platform and Version

aio -v
@adobe/aio-cli/2.3.0 darwin-x64 node-v10.16.0

Sample Code that illustrates the problem

Logs taken while reproducing problem

Expected Behaviour

createProfile should return newly inserted profile or error is missing parameter.

Actual Behaviour

 stdout: 2019-12-13T15:14:32.341Z [MyApp /delaland/techlab-cna-paris-0.0.1/createprofile] info: Calling the create profile action...
2019-12-13T15:14:32.341Z       stdout: logging create profile
2019-12-13T15:14:32.715Z       stdout: 2019-12-13T15:14:32.715Z [MyApp /delaland/techlab-cna-paris-0.0.1/createprofile] error: [CampaignStandardSDK:ERROR_CREATE_PROFILE] 404 - Not Found ("RST-360011 An error has occurred - please contact your administrator. Error rc=-2003")

Steps to Reproduce

    // initialize the sdk
    const campaignClient = await CampaignStandard.init(params.tenant, params.apiKey, tokenResults.token)
   const createResult = await campaignClient.createProfile({email: '[email protected]','firstName': 'clement', 'lastName': 'del'})

Platform and Version

aio -v
@adobe/aio-cli/2.2.3 darwin-x64 node-v12.9.1

Sample Code that illustrates the problem

Code available in git

Logs taken while reproducing problem

Expected Behaviour

For triggerSignalActivity, one has to first call getWorkflow, which returns a URL for triggering signal activity. That URL is then called, with required parameters, to trigger a workflow.
As the URL returned by getWorkflow is a full URL, e.g. https://mc.adobe.io/<ORGANIZATION>/campaign/workflow/execution/@19K_8ZhwSr_6KVriV4X8gw3YThAY-TAjJjV4vHmUiwTm_0kpgzQ-fa3x8KCLfb8FjjR53mJ22GYuLoaHLovKIuxoGXDvHXtuSSrLsbbT5PA9Dkezt6tzIA7hNTAR9oBun6cMHA/activities/activity/@19K_8ZhwSr_6KVriV4X8gw3YThAY-TAjJjV4vHmUiwTm_0kpgzQ-fa3x8KCLfb8FjjR53mJ22GYuLoaHLovKIgIFKtEyaPUqUf02xvnDBod6C2DYV0M8pVdXnSo-Xx2RMbKbAeJhFjtO0FUWO6WeouJQMcvkTwRhgdxyQ0nbh_jqAV11/trigger, it needs to be called in a "request" lib manner rather than a path of Swagger def.

Actual Behaviour

When calling acsClient.triggerSignalActivity(triggerUrl, wfParams), we will get Internal server error, because with triggerUrl being https://mc.adobe.io/..., the actual call will be to https://mc.adobe.io/adobeiosolutionsdemo/campaign/https://mc.adobe.io/adobeiosolutionsdemo/campaign/workflow/execution/....

Sample Code that illustrates the problem

const acsClient = await sdk.init(tenantId, authClientId, jwtToken)
const workflow = await acsClient.getWorkflow('myWkfId')
const wkfHref = workflow.body.activities.activity.signal1.trigger.href
await acsClient.triggerSignalActivity(processTriggerUrl(wkfHref), { source: 'API', parameters: { email: args.email } })

Logs taken while reproducing problem

Error while calling Adobe Campaign Standard triggerSignalActivity - Error: Internal Server Error

🚨 Reminder! Less than one month left to migrate your repositories over to Snyk before Greenkeeper says goodbye on June 3rd! 💜 🚚💨 💚

Find out how to migrate to Snyk at greenkeeper.io

The devDependency eslint-plugin-jest was updated from 23.9.0 to 23.10.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint-plugin-jest is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

There are 4 resources:

1. Profile
2. Service
3. History
4. OrgUnitBase

For each resource you can get all the records for each resource, except for History (not specified in the docs, and it the docs always show a PKey is required). getAllServices method is missing.

See https://docs.campaign.adobe.com/doc/standard/en/api/ACS_API.html#filtering
under the profileAndServicesExt endpoint

Right now the output is only in HTML. Add Markdown as well.

Some might not be familiar with async/await. Show a proper example with an async function so the await will work. Maybe also provide a Promises example.

Expected Behaviour

e2e test getAllProfiles bad tenant id test should fail in an expected way.

Actual Behaviour

e2e test getAllProfiles bad tenant id test fails in unexpected ways, depending on a cold or warm start (for the Campaign Standard server). If cold, it fails with http 400, while when warm it fails with http 500.

Reproduce Scenario (including but not limited to)

Run the e2e tests with credentials.

Steps to Reproduce

npm run e2e with the appropriate .env credentials file.

The test is here

Proposed fix

Modify the test to test for http code >= 400, not just 500.

Can we add functionality to get a single custom resource?

add parameter to filter the custom resource.

Example:
result = await acsClient.getCustomResource("cusTriggerData");

Thanks in advance.

The methods are:

• getAllProfiles
• getAllOrgUnits
• getAllServices

Query Parameters supported:

• _lineCount (integer)
• _order (string)

Filters

Filters depend on the resource (do a getMetadataForResource call). They are specified in the URL after the resource, and can be chained.

Thus, if your resource is at /profileAndServices/profile and you have a filter filter1, your url will be: /profileAndServices/profile/filter1

If your resource is at /profileAndServices/profile and you have filters filter1 and filter2, your url will be: /profileAndServices/profile/filter1/filter2 (chain them)

Record Column Selection

Instead of a filter, you can also "select" a field from the resource (think of a database table selection), by specifying the field after the resource. You can only select one field. For example, if you want the Profile records returned to only select the "email" field, your url will be:
/profileAndServices/profile/email

Example Call

const params = {
    lineCount: 10, // pagination: default 25
    order: 'email',  // sort: what field to sort on
    descendingSort: true // sort: default is ascending
}
const filters = [ 'byEmail', 'byText' ]
getAllProfiles(filters, params)

For example getAllServices() the parameter is not required, and will have a default. Go through all the functions

This is because there is no way to intercept request/response. axios provides this. This is for debug logging. Works in the browser as well.

Is it possible to add the feature to add data to custom resources?

Currently it is only possible to retrieve all customResources (getCustomResources)

API path
/profileAndServicesExt/{customResourceKey}

Where customResourceKey is input provided as a parameter, for example a value would be cusTriggerData.

This also expects a body to be provided. The body will consist of the fields of that custom resource.

After successfully initializing with the parameters (tenantID, apiKey, accessToken). Parameters have been tested with Postman. When calling getAllServices, I see the below error:
Error: Error while calling Adobe Campaign Standard getAllServices - Error: Not Found

Can we change this to a more descriptive error?

Verbose output for debugging is using the DEBUG environment variable.

DEBUG=adobeio-cna-core-campaign-standard  <your_call_here>

Prepend that to the call that invokes your function, on the command line. This should output a lot of debug data.

the link from the readme is a 404 :)

please add that before you open source, thanks!

Expected Behaviour

The API call succeeds.

Actual Behaviour

The API call fails with an Internal Server Error.

Steps to Reproduce

Verify that the call via REST API succeeds in Postman (export to curl and verify again)
Use LOG_LEVEL=debug to see the SDK request and response

Fix

The SDK's request URL has an extra comma at the end. Adding this extra comma via Postman or curl verifies that it causes the same error.

The fix is to make sure the request url is well formed in the SDK (some path parameters might be missing default values)

cc @dhindle

See: https://jira.corp.adobe.com/browse/AIOE-109

Expected Behaviour

The request should be:
https://%tenantid%-adobeio.campaign.adobe.com/rest/customResource/cusMarketingHistory

Actual Behaviour

The request is:
https://%tenantid%-adobeio.campaign.adobe.com/rest/profileAndServicesExt/cusMarketingHistory

Reproduce Scenario (including but not limited to)

In ACS, create a customRessource without any link (no link to Profiles for instance)
Publish it.

Steps to Reproduce

Create an IO action and try to retrieve all the records of this custom resource, by using this kind of code:
const marketingHistoryRecords =await campaignClient.getAllCustomResources(customResourceName, {})

Platform and Version

@adobe/aio-cli/3.3.0 win32-x64 node-v10.16.0

Sample Code that illustrates the problem

Logs taken while reproducing problem

__secured_getmarketinghistory:ee99b25448a5453799b25448a5853754
2020-05-04T09:12:49.187Z stdout: 2020-05-04T09:12:49.186Z [main /bouessay/marketinghisto-app-0.0.1/__secured_getmarketinghistory] info: Calling the main action
2020-05-04T09:12:49.187Z stdout: 2020-05-04T09:12:49.187Z [main /bouessay/marketinghisto-app-0.0.1/__secured_getmarketinghistory] debug: {"statusCode":200,"body":{"message":"validation success"},"tenant":"intersportfrance-mkt-stage1","__ow_method":"post","apiKey":"0ca1f0006e494d9c8b713a92b82df1a0","LOG_LEVEL":"debug","__ow_headers":{"accept":"/","accept-encoding":"gzip, deflate, br","accept-language":"en-US, en;q=0.5","authorization":"","cache-control":"no-cache","connection":"close","content-type":"application/json","host":"controller-a","origin":"https://localhost:9080","perf-br-req-in":"1588583568.311","pragma":"no-cache","referer":"https://localhost:9080/?_mr=https%3A%2F%2Fexperience.adobe.com%2Fassets%2Fruntime.28bb2226.js&shell_domain=experience.adobe.com","user-agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:75.0) Gecko/20100101 Firefox/75.0","x-forwarded-for":"193.104.215.11, 10.250.204.235","x-forwarded-host":"bouessay.adobeioruntime.net","x-forwarded-port":"443","x-forwarded-proto":"https","x-org-id":"03AA65E45DD69DB50A495C94@AdobeOrg","x-real-ip":"10.250.204.235","x-request-id":"LI1ECmqqDb3BZPXZs7mhhS3alcPPUWh1"},"__ow_path":""}
2020-05-04T09:12:49.213Z stdout: 2020-05-04T09:12:49.213Z [aio-lib-campaign-standard] debug: sdk initialized successfully
2020-05-04T09:12:49.213Z stdout: 2020-05-04T09:12:49.213Z [main /bouessay/marketinghisto-app-0.0.1/__secured_getmarketinghistory] debug: before call getAllCustomResources cusMarketingHistory
2020-05-04T09:12:49.219Z stdout: 2020-05-04T09:12:49.219Z [aio-lib-campaign-standard] debug: REQUEST:
{
"url": "https://mc.adobe.io/intersportfrance-mkt-stage1/campaign/profileAndServicesExt/cusMarketingHistory/",
"credentials": "same-origin",
"headers": {
"X-Api-Key": "0ca1f0006e494d9c8b713a92b82df1a0",
"Authorization": "Bearer [hidden-data]"
},
"method": "GET",
"body": "{}"
}
2020-05-04T09:12:50.360Z stdout: 2020-05-04T09:12:50.360Z [aio-lib-campaign-standard] debug: RESPONSE:
{
"ok": false,
"url": "https://mc.adobe.io/intersportfrance-mkt-stage1/campaign/profileAndServicesExt/cusMarketingHistory/",
"status": 404,
"statusText": "Not Found",
"headers": {
"content-type": "text/plain; charset=utf-8",
"date": "Mon, 04 May 2020 09:12:50 GMT",
"server": "openresty",
"strict-transport-security": "max-age=31536000",
"x-content-type-options": "nosniff",
"x-debug-backend": "https://intersportfrance-mkt-stage1-adobeio.campaign.adobe.com/rest/profileAndServicesExt/cusMarketingHistory/",
"x-request-id": "OaQgC5fhTUfdmEOSD5Yx29MUcqew2UQk",
"x-robots-tag": "noindex",
"x-xss-protection": "1; mode=block",
"content-length": "93",
"connection": "Close"
},
"text": "RST-360011 Une erreur s’est produite. Veuillez contacter l’administrateur.\nError rc=-2003",
"data": "RST-360011 Une erreur s’est produite. Veuillez contacter l’administrateur.\nError rc=-2003",
"body": "RST-360011 Une erreur s’est produite. Veuillez contacter l’administrateur. Error rc=-2003",
"obj": "RST-360011 Une erreur s’est produite. Veuillez contacter l’administrateur. Error rc=-2003"
}
2020-05-04T09:12:50.361Z stdout: 2020-05-04T09:12:50.361Z [main /bouessay/marketinghisto-app-0.0.1/__secured_getmarketinghistory] error: [CampaignStandardSDK:ERROR_GET_ALL_CUSTOM_RESOURCES] 404 - Not Found ("RST-360011 Une erreur s’est produite. Veuillez contacter l’administrateur. Error rc=-2003")
2020-05-04T09:12:50.361Z stdout: 2020-05-04T09:12:50.361Z [main /bouessay/marketinghisto-app-0.0.1/__secured_getmarketinghistory] info: 500: server error

File .github/workflows/node.js.yml. See https://github.com/adobe/aio-cli-plugin-app/blob/5670908e7ef7ba63c903ee924520eeb018a9e448/.github/workflows/node.js.yml#L32-L36

While using the Campaign Standard libraries, using getMetadataForResource(resource) does not fetch the custom/extended attributes related to resource.

Expected Behaviour

getMetadataForResource(resource) library method should pull all the attributes defined for a resource in Adobe Campaign Standard.

Actual Behaviour

getMetadataForResource(resource) library method fetches the default attributes related to resource.

Reproduce Scenario (including but not limited to)

(1) In Adobe Campaign Standard, navigate to Custom resources [Administration > Development > Custom resources]
(2) Click "CREATE" button and select "Extend and existing resource" (basically developers add business use case related custom/extended attributes to existing resource)
(3) Select "Profile" resource
(4) Add some simple attributes of type text / date / integer etc.
(5) Define new links to other attributes to extended resource
(6) Publish resource and the Adobe Campaign Standard forms allows users to populate the newly added attributes.

Steps to Reproduce

Nodesjs:

const acs = require('@adobe/aio-lib-campaign-standard');
const TENANT = "...";
const CLIENT_ID = "...";
const TOKEN = "...";
let get_metadata = async function (tenant, client_id, token, resource) {
    let acs_instance = await acs.init(tenant, client_id, token);
    return await acs_instance.getMetadataForResource(resource);
};

Invoke:

get_metadata(TENANT, CLIENT_ID, TOKEN, "profile").then(function (response) { console.log("success"); console.log(JSON.stringify(response))}).catch(function(error){console.log("error"); console.log(error)});

Response is success; however, does not show the newly added attributes in the response.
But if you refer response.body.href and use AJAX to retrieve the metadata; you can find all custom/extended attributes.

Platform and Version

aio -v
@adobe/aio-cli/2.3.0 darwin-x64 node-v10.16.0

Sample Code that illustrates the problem

Logs taken while reproducing problem

In the OpenAPI spec, the http method is PATCH when it should be GET

For "custom resources" in ACS, there are currently 2 APIs being exposed:

• https://%tenantid%-adobeio.campaign.adobe.com/rest/customResources
• https://%tenantid%-adobeio.campaign.adobe.com/rest/profileAndServicesExt

In the SDK, we currently expose getAllCustomResources() method, which basically calls /customResources behind the scene. However we don't have any method for /profileAndServicesExt, which contains profile, services and linked customer resources.

Therefore, we need to expose another method for /profileAndServicesExt, e.g. getAllProfileCustomResources().

This will fix #60 .

Rename in package.json as well.
Hasn't been published to npm yet so we don't have to deprecate.

🚨 Reminder! Less than one month left to migrate your repositories over to Snyk before Greenkeeper says goodbye on June 3rd! 💜 🚚💨 💚

Find out how to migrate to Snyk at greenkeeper.io

The dependency swagger-client was updated from 3.10.1 to 3.10.2.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

swagger-client is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

Hi,

External Signal activities in ACS can only be called once every 10 minutes. This is a hardcoded restriction to prevent serious issues in the workflows.

When you use triggerSignalActivity() for an ACS workflow during this 10 minute wait, it will result in an error like this:

error: [CampaignStandardSDK:ERROR_TRIGGER_SIGNAL_ACTIVITY] FetchError: invalid json response body at [URL OF THE TRIGGER] reason: Unexpected token T in JSON at position 0
    at /nodejsAction/dKXSJgAz/index.js:16453:32
    at processTicksAndRejections (internal/process/task_queues.js:97:5) {
  type: 'invalid-json'
}

This is very likely due to ACS responding in a non-JSON form whenever a trigger is called it cannot execute.

Currently we have only one option to create a Profile but the API supports two ways of creating a profile. The endpoints for these two ways are different.
The original and already supported way is the /campaign/profileAndServices/profile but you also have the option to create a profile via /campaign/profileAndServicesExt/profile. In a project that I am working on this is creating an issue because I am unable to create valid profiles for the environment that are attached to a orgUnit.

Could we add support for this?

It looks like all methods that call GET endpoints are failing by this error TypeError: Request with GET/HEAD method cannot have body. Tested with getAllProfiles and getAllProfileAndServicesExt.

Example code

// initialize the sdk
const campaignClient = await CampaignStandard.init(params.tenant, params.apiKey, token)

// get profiles from Campaign Standard
const profiles = await campaignClient.getAllProfiles()

Expected Behaviour

Such as reported for campaignStandardCoreAPI.sendTransactionalEvent in #59, the MAC tenant id used by the API call can be different from the org id.

A similar fix than the one applied to #59 should be implemented, and the current getTransactionEvent function deprecated in favor of the new one.

Actual Behaviour

As of now, the SDK library code assumes both MAC tenant id and org id have the same value.