Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dataFlow is missing on DataFactory Activity responses #24651

Closed
2 tasks done
btimperman-pantomath opened this issue Feb 1, 2023 · 4 comments
Closed
2 tasks done

dataFlow is missing on DataFactory Activity responses #24651

btimperman-pantomath opened this issue Feb 1, 2023 · 4 comments
Assignees
Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. customer-reported Issues that are reported by GitHub users external to the Azure organization. Data Factory Mgmt This issue is related to a management-plane library. needs-author-feedback Workflow: More information is needed from author to address the issue. no-recent-activity There has been no recent activity on this issue. Service Attention Workflow: This issue is responsible by Azure service team.

Comments

@btimperman-pantomath
Copy link

btimperman-pantomath commented Feb 1, 2023

  • Package Name: @azure/arm-datafactory
  • Package Version: 10.10.2
  • Operating system: Linux
  • nodejs
    • version: 14.21.2
  • typescript
    • version: 4.6.3

Describe the bug
The ActivityUnion objects nested in the PipelineResource object returned by dataFactoryClient.pipelines.listByFactory() are missing the dataFlow field, even though this is present in the REST API JSON response.

To Reproduce
Steps to reproduce the behavior:

  1. Create an ADF pipeline with an activity that executes a Data Flow.
  2. Call dataFactoryClient.pipelines.listByFactory().
  3. The ActivityUnion representing the above activity will have an undefined dataFlow field.

Expected behavior
The dataFlow field should be populated with a DataFlowReference.

Additional context
This happens because the serializedName field in sdk/datafactory/arm-datafactory/src/models/mappers.ts has a typo pointing to an incorrect field on the JSON response. The correct field on the REST API JSON response is typeProperties.dataflow not typeProperties.dataFlow.

@ghost ghost added needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. customer-reported Issues that are reported by GitHub users external to the Azure organization. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Feb 1, 2023
btimperman-pantomath added a commit to btimperman-pantomath/azure-sdk-for-js that referenced this issue Feb 1, 2023
@xirzec xirzec added the Mgmt This issue is related to a management-plane library. label Feb 1, 2023
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Feb 1, 2023
@xirzec xirzec added bug This issue requires a change to an existing behavior in the product in order to be resolved. Data Factory needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. and removed question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Feb 1, 2023
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Feb 1, 2023
@qiaozha
Copy link
Member

qiaozha commented Feb 2, 2023

From the swagger https://github.com/Azure/azure-rest-api-specs/blob/main/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json#L7390-L7393, it is called dataFlow. I guess there's a mismatch between the service backend and their rest api specs.

@qiaozha qiaozha added the Service Attention Workflow: This issue is responsible by Azure service team. label Feb 2, 2023
@ghost
Copy link

ghost commented Feb 2, 2023

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @Jingshu923, @zhangyd2015, @Frey-Wang.

Issue Details
  • Package Name: @azure/arm-datafactory
  • Package Version: 10.10.2
  • Operating system: Linux
  • nodejs
    • version: 14.21.2
  • typescript
    • version: 4.6.3

Describe the bug
The ActivityUnion objects nested in the PipelineResource object returned by dataFactoryClient.pipelines.listByFactory() are missing the dataFlow field, even though this is present in the REST API JSON response.

To Reproduce
Steps to reproduce the behavior:

  1. Create an ADF pipeline with an activity that executes a Data Flow.
  2. Call dataFactoryClient.pipelines.listByFactory().
  3. The ActivityUnion representing the above activity will have an undefined dataFlow field.

Expected behavior
The dataFlow field should be populated with a DataFlowReference.

Additional context
This happens because the serializedName field in sdk/datafactory/arm-datafactory/src/models/mappers.ts has a typo pointing to an incorrect field on the JSON response. The correct field on the REST API JSON response is typeProperties.dataflow not typeProperties.dataFlow.

Author: btimperman-pantomath
Assignees: qiaozha
Labels:

bug, customer-reported, Mgmt, Service Attention, Data Factory

Milestone: -

@ghost ghost added the needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team label Feb 2, 2023
@MaryGao
Copy link
Member

MaryGao commented Mar 14, 2023

@btimperman-pantomath Could you share the type you refered in the list operation in ActivityUnion?

We tested in our side and found the dataFlow is not undefined and here is our traffic recording file.

for await (let item of client.pipelines.listByFactory(resourceGroup, factoryName)) {
resArray.push(item);
}
assert.equal(resArray.length, 1);
assert.equal(resArray[0].activities?.length, 1);
assert.equal(resArray[0].activities![0].type, "ExecuteWranglingDataflow");
assert.equal(resArray[0].activities![0].dataFlow.type, "DataFlowReference");

Please notice the property dataFlow is only valid for part of activities like ExecuteWranglingDataflow

export interface ExecuteWranglingDataflowActivity extends Activity {
/** Polymorphic discriminator, which specifies the different types this object can be */
type: "ExecuteWranglingDataflow";
/** Activity policy. */
policy?: ActivityPolicy;
/** Data flow reference. */
dataFlow: DataFlowReference;
.

@MaryGao MaryGao added needs-author-feedback Workflow: More information is needed from author to address the issue. and removed needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team labels Mar 14, 2023
@MaryGao MaryGao self-assigned this Mar 15, 2023
MaryGao pushed a commit that referenced this issue Mar 17, 2023
@ghost ghost added the no-recent-activity There has been no recent activity on this issue. label Mar 22, 2023
@ghost
Copy link

ghost commented Mar 22, 2023

Hi, we're sending this friendly reminder because we haven't heard back from you in a while. We need more information about this issue to help address it. Please be sure to give us your input within the next 7 days. If we don't hear back from you within 14 days of this comment the issue will be automatically closed. Thank you!

@ghost ghost closed this as completed Apr 6, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Jul 5, 2023
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. customer-reported Issues that are reported by GitHub users external to the Azure organization. Data Factory Mgmt This issue is related to a management-plane library. needs-author-feedback Workflow: More information is needed from author to address the issue. no-recent-activity There has been no recent activity on this issue. Service Attention Workflow: This issue is responsible by Azure service team.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants