chore: re-order folder structure for types #4090

utsabc · 2025-02-18T10:40:30Z

What are the changes introduced in this PR?

This PR cleans up the siloed type definitions that we have in v0/utils/types/index.ts and distributes them into appropriate files

What is the related Linear task?

Resolves INT-3304

Please explain the objectives of your changes below

Put down any required details on the broader aspect of your changes. If there are any dependent changes, mandatorily mention them here

Any changes to existing capabilities/behaviour, mention the reason & what are the changes ?

N/A

Any new dependencies introduced with this change?

N/A

Any new generic utility introduced or modified. Please explain the changes.

N/A

Any technical or performance related pointers to consider with the change?

N/A

@coderabbitai review

Developer checklist

My code follows the style guidelines of this project
No breaking changes are being introduced.
All related docs linked with the PR?
All changes manually tested?
Any documentation changes needed with this change?
Is the PR limited to 10 file changes?
Is the PR limited to one linear task?
Are relevant unit and component test-cases added in new readability format?

Reviewer checklist

Is the type of change in the PR title appropriate as per the changes?
Verified that there are no credentials or confidential data exposed with the changes.

devops-github-rudderstack · 2025-02-18T10:47:55Z

Allure Test reports for this run are available at:

Allure Report: https://rudderlabs.github.io/rudder-transformer/426/index.html

codecov · 2025-02-18T10:47:59Z

Codecov Report

Attention: Patch coverage is 90.62500% with 3 lines in your changes missing coverage. Please review.

Project coverage is 91.16%. Comparing base (ebd305b) to head (78fde45).
Report is 13 commits behind head on develop.

Files with missing lines	Patch %	Lines
src/v0/destinations/ga4_v2/transform.ts	0.00%	2 Missing ⚠️
...c/v0/destinations/customerio_audience/transform.ts	95.65%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #4090      +/-   ##
===========================================
+ Coverage    91.12%   91.16%   +0.03%     
===========================================
  Files          631      632       +1     
  Lines        32944    33112     +168     
  Branches      7807     7838      +31     
===========================================
+ Hits         30021    30186     +165     
- Misses        2673     2708      +35     
+ Partials       250      218      -32

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/types/index.ts

src/types/sourceTransformtionContracts.ts

devops-github-rudderstack · 2025-02-24T06:30:48Z

Allure Test reports for this run are available at:

Allure Report: https://rudderlabs.github.io/rudder-transformer/480/index.html

krishna2020 · 2025-02-24T09:01:24Z

src/types/controlPlaneConfigSpec.ts

+  Config: FixMe;
+};
+
+export type Destination<DestinationConfig = FixMe> = {


can we add DestinationConfig type ?

This is dynamic for each specific destination depending on what config is defined in destinationDefinition

Instead of FixMe (which is basically any) can we a bit more context sensitive types?

unknown

Record<string, any> ( for object structures ) etc

At the minimum, we can get the table structure of destConfig. As vinay pointed out, FixMe is the one which I want to avoid

krishna2020 · 2025-02-24T09:07:51Z

src/types/transformation.ts

+/**
+ * Router transformation structures
+ */
+export type RouterTransformationRequestData<


why to define type parameters here ?

Can you elaborate?

why to set these parameters
Message = object,
DestinationType = Destination,
ConnectionType = Connection,

src/types/transformation.ts

vinayteki95 · 2025-02-25T11:20:33Z

src/types/eventSpec.ts

+export type MessageIdMetadataMap = {
+  [key: string]: Metadata;
+};


If there are no know keys and all are optional, we should use this to make it more readable and concise

export type MessageIdMetadataMap = Record<string, Metadata>;

vinayteki95 · 2025-02-25T11:32:05Z

src/types/transformation.ts

+export type ProxyV1Request = {
+  version: string;
+  type: string;
+  method: string;
+  endpoint: string;
+  userId: string;
+  headers?: Record<string, unknown>;
+  params?: Record<string, unknown>;
+  body?: {
+    JSON?: Record<string, unknown>;
+    JSON_ARRAY?: Record<string, unknown>;
+    XML?: Record<string, unknown>;
+    FORM?: Record<string, unknown>;
+  };
+  files?: Record<string, unknown>;
+  metadata: ProxyMetdata[];
+  destinationConfig: Record<string, unknown>;
+};


Maybe instead of duplicating the entire type, we can simplify it like this?

export type ProxyV1Request = Omit<ProxyV0Request, "metadata"> & { metadata: ProxyMetdata[]; };

This can clearly indicate that the only difference in these 2 times comes from the field metadata

devops-github-rudderstack · 2025-02-26T08:51:18Z

Allure Test reports for this run are available at:

Allure Report: https://rudderlabs.github.io/rudder-transformer/515/index.html

src/v0/destinations/customerio_audience/transform.ts

koladilip · 2025-02-26T11:29:41Z

Codecov Report

Attention: Patch coverage is 78.57143% with 6 lines in your changes missing coverage. Please review.

Project coverage is 91.15%. Comparing base (c200518) to head (728e220).
Report is 38 commits behind head on develop.

Files with missing lines Patch % Lines
...c/v0/destinations/customerio_audience/transform.ts 77.77% 4 Missing ⚠️
src/v0/destinations/ga4_v2/transform.ts 0.00% 1 Missing and 1 partial ⚠️
Additional details and impacted files

☔ View full report in Codecov by Sentry. 📢 Have feedback on the report? Share it here.

fix these

…to chore.types-re-order

devops-github-rudderstack · 2025-02-27T14:31:36Z

Allure Test reports for this run are available at:

Allure Report: https://rudderlabs.github.io/rudder-transformer/532/index.html

devops-github-rudderstack · 2025-02-28T05:26:11Z

Allure Test reports for this run are available at:

Allure Report: https://rudderlabs.github.io/rudder-transformer/537/index.html

sonarqubecloud · 2025-02-28T05:27:45Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

chore: re-order folder structure for types

8111aa1

utsabc requested review from sivashanmukh and a team as code owners February 18, 2025 10:40

utsabc requested review from krishna2020, vinayteki95 and koladilip February 18, 2025 10:40

koladilip reviewed Feb 18, 2025

View reviewed changes

src/types/index.ts Outdated Show resolved Hide resolved

src/types/sourceTransformtionContracts.ts Outdated Show resolved Hide resolved

krishna2020 mentioned this pull request Feb 23, 2025

refactor: move few cdk integrations to ts #4083

Open

10 tasks

chore: update the file name for type files

bc1a8d1

koladilip previously approved these changes Feb 24, 2025

View reviewed changes

krishna2020 reviewed Feb 24, 2025

View reviewed changes

src/types/transformation.ts Show resolved Hide resolved

vinayteki95 reviewed Feb 25, 2025

View reviewed changes

chore: fix type references

728e220

utsabc dismissed koladilip’s stale review via 728e220 February 26, 2025 08:44

utsabc requested review from a team as code owners February 26, 2025 08:44

utsabc requested review from krishna2020 and sandeepdsvs February 26, 2025 08:44

koladilip reviewed Feb 26, 2025

View reviewed changes

src/v0/destinations/customerio_audience/transform.ts Show resolved Hide resolved

koladilip previously approved these changes Feb 26, 2025

View reviewed changes

utsabc added 2 commits February 27, 2025 12:08

Merge branch 'develop' of github.com:rudderlabs/rudder-transformer in…

b2fa2cf

…to chore.types-re-order

fix: add test cases for cio_audience

ad30f10

utsabc dismissed koladilip’s stale review via ad30f10 February 27, 2025 14:24

fix: minor fix

78fde45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: re-order folder structure for types #4090

chore: re-order folder structure for types #4090

utsabc commented Feb 18, 2025 •

edited

Loading

devops-github-rudderstack commented Feb 18, 2025

codecov bot commented Feb 18, 2025 •

edited

Loading

devops-github-rudderstack commented Feb 24, 2025

krishna2020 Feb 24, 2025

utsabc Feb 24, 2025 •

edited

Loading

vinayteki95 Feb 25, 2025

krishna2020 Feb 25, 2025

utsabc Feb 28, 2025

krishna2020 Feb 24, 2025

utsabc Feb 24, 2025

krishna2020 Feb 25, 2025

utsabc Feb 28, 2025

vinayteki95 Feb 25, 2025

utsabc Feb 28, 2025

vinayteki95 Feb 25, 2025 •

edited

Loading

utsabc Feb 28, 2025

devops-github-rudderstack commented Feb 26, 2025

koladilip commented Feb 26, 2025

Codecov Report

devops-github-rudderstack commented Feb 27, 2025

devops-github-rudderstack commented Feb 28, 2025

sonarqubecloud bot commented Feb 28, 2025

chore: re-order folder structure for types #4090

Are you sure you want to change the base?

chore: re-order folder structure for types #4090

Conversation

utsabc commented Feb 18, 2025 • edited Loading

What are the changes introduced in this PR?

What is the related Linear task?

Please explain the objectives of your changes below

Any changes to existing capabilities/behaviour, mention the reason & what are the changes ?

Any new dependencies introduced with this change?

Any new generic utility introduced or modified. Please explain the changes.

Any technical or performance related pointers to consider with the change?

Developer checklist

Reviewer checklist

devops-github-rudderstack commented Feb 18, 2025

codecov bot commented Feb 18, 2025 • edited Loading

Codecov Report

devops-github-rudderstack commented Feb 24, 2025

Choose a reason for hiding this comment

utsabc Feb 24, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vinayteki95 Feb 25, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devops-github-rudderstack commented Feb 26, 2025

koladilip commented Feb 26, 2025

Codecov Report

devops-github-rudderstack commented Feb 27, 2025

devops-github-rudderstack commented Feb 28, 2025

sonarqubecloud bot commented Feb 28, 2025

Quality Gate passed

utsabc commented Feb 18, 2025 •

edited

Loading

codecov bot commented Feb 18, 2025 •

edited

Loading

utsabc Feb 24, 2025 •

edited

Loading

vinayteki95 Feb 25, 2025 •

edited

Loading