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.

Sign up for GitHub

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

Jump to bottom

feat(FN-3163): MDM endpoints for automatically creating new DTFS customers in Salesforce #1057

Closed

natdeanlewissoftwire wants to merge 144 commits into create-customer-endpoint-dnb-service from create-customer-endpoint

Contributor

natdeanlewissoftwire commented Nov 8, 2024 •

edited

Loading

Introduction ✏️

As part of the CCM project, if a customer does exist in SF, we are automatically creating it rather than relying on the manual process currently undertaken by Business Support Group. DTFS will send requests to a new customer/salesforce endpoint for MDM to create a customer in Salesforce. Technical documentation of this process is here

The corresponding feature-flagged DTFS pull request is here.

Resolution ✔️

This PR adds a "get or create" salesforce customer endpoint that does a few things:
Checks for an existing customer via Informatica. If none exists (or we return a legacy one):
Generates a URN from NUMGEN (if there isn't already one returned from a legacy record by Informatica, in which case we just use that).
Calls the new Dun and Bradstreet service (in a separate PR, here) to get a customer's DUNS number.
POSTs these along with the customer name and Companies House Number to Salesforce.
Returns the customer, including the URN to DTFS for deal submission.

Miscellaneous ➕

A tweak to the NUMGEN regex to allow customer URN creation, and a typo fix.
To be merged after this PR

natdeanlewissoftwire had a problem deploying to qa

November 8, 2024 16:57

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 8, 2024 16:57

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 8, 2024 16:57

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 8, 2024 16:57

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 8, 2024 16:57

— with

GitHub Actions Failure

natdeanlewissoftwire changed the title ~~Create customer endpoint~~ feat(FN-3163): MDM endpoints for automatically creating new DTFS customers in Salesforce

github-advanced-security bot found potential problems

View reviewed changes

src/modules/salesforce/salesforce.module.ts Fixed Show fixed Hide fixed

natdeanlewissoftwire mentioned this pull request

feat(FN-3163): MDM endpoints for automatically creating new DTFS customers in Salesforce (Dun and Bradstreet service only) #1056

Closed

natdeanlewissoftwire had a problem deploying to qa

November 11, 2024 11:03

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 11, 2024 11:03

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 11, 2024 11:03

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 11, 2024 11:03

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 11, 2024 11:03

— with

GitHub Actions Failure

natdeanlewissoftwire commented

View reviewed changes

src/modules/salesforce/salesforce.module.ts

+                        // to ignore https issues, enable agent and rejectUnauthorized:false bellow.
+                        httpsAgent: new https.Agent({
+                          // Allow self signed negotiations
+                          // rejectUnauthorized: false,

Contributor Author

natdeanlewissoftwire Nov 11, 2024 •

edited

Loading

This needs to be uncommented to work locally (due to a self-signed certificate in certificate chain: error) but on prod it should work fine... I'm not that happy with this state of things so if there's a better way that allows it to work everywhere without tweaking the code that'd be ideal.

natdeanlewissoftwire had a problem deploying to qa

November 11, 2024 11:22

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 11, 2024 11:22

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 11, 2024 11:22

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 11, 2024 11:22

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 11, 2024 11:22

— with

GitHub Actions Failure

natdeanlewissoftwire mentioned this pull request

feat(FN-3163): MDM endpoints for automatically creating new DTFS customers in Salesforce GET only #1065

Closed

natdeanlewissoftwire had a problem deploying to qa

November 19, 2024 17:09

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 19, 2024 17:09

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 19, 2024 17:09

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 19, 2024 17:09

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 19, 2024 17:09

— with

GitHub Actions Failure

natdeanlewissoftwire force-pushed the create-customer-endpoint branch from e275934 to 8787e3d Compare

November 27, 2024 08:52


          feat: add DnB behaviour ready for use in customers service

4cf255c

natdeanlewissoftwire had a problem deploying to qa

November 27, 2024 08:53

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 27, 2024 08:53

— with

GitHub Actions Failure

natdeanlewissoftwire had a problem deploying to qa

November 27, 2024 08:53

— with

GitHub Actions Failure

Nat Dean-Lewis added 13 commits

December 5, 2024 15:09


          feat: add informatica failure tests

4b303c9


          refactor: cleanup

b0ab9e1


          feat: add legacy behaviour and tests

1fef264


          docs: update sf numgen comment

6ccdcdd


          feat: update duplicate error message

54fb187


          feat: specify dynamic success status code for getOrCreate


          test: update controller tests

50ff093


          test: update controller tests

6e77f83


          refactor: remove logging

27f7a63


          feat: update customer service tests

52eeff8


          refactor: lint

7e014f9


          refactor: lint

3a2c84e


          Merge branch 'create-customer-endpoint' of https://github.com/UK-Expo…

482b193

…rt-Finance/mdm-api into create-customer-endpoint

sonarqubecloud bot commented Dec 5, 2024

Quality Gate failed

Failed conditions
2 Security Hotspots

See analysis details on SonarQube Cloud

natdeanlewissoftwire changed the base branch from create-customer-endpoint-dnb-service to main

December 5, 2024 15:10

natdeanlewissoftwire changed the base branch from main to create-customer-endpoint-dnb-service

December 5, 2024 15:11

natdeanlewissoftwire requested review from avaitonis and abhi-markan

December 9, 2024 09:02

avaitonis reviewed

View reviewed changes

src/modules/customers/customers.service.ts

+                        let dunsNumber: string = null;
+                        try {
+                          dunsNumber = await this.dunAndBradstreetService.getDunAndBradstreetNumberByRegistrationNumber(DTFSCustomerDto.companyRegistrationNumber);
+                        } catch (error) {

Contributor

avaitonis Jan 6, 2025

Maybe this try catch is unnecessary? or does it provide any benefit?

avaitonis reviewed

View reviewed changes

src/modules/customers/customers.service.ts

+                          const createdCustomer = await this.createCustomerByURNAndDUNS(DTFSCustomerDto, partyUrn, dunsNumber, isLegacyRecord);
+                          res.status(201).json(createdCustomer);
+                          return;
+                        } catch (error) {

Contributor

avaitonis Jan 6, 2025

Maybe this try catch is unnecessary? or does it provide any benefit?

avaitonis reviewed

View reviewed changes

src/modules/customers/customers.service.ts

+                      let dunsNumber: string = null;
+                      try {
+                        dunsNumber = await this.dunAndBradstreetService.getDunAndBradstreetNumberByRegistrationNumber(DTFSCustomerDto.companyRegistrationNumber);
+                      } catch (error) {

Contributor

avaitonis Jan 6, 2025

Maybe this try catch is unnecessary? or does it provide any benefit?

avaitonis reviewed

View reviewed changes

src/modules/customers/customers.service.ts

+                        const createdCustomer = await this.createCustomerByURNAndDUNS(DTFSCustomerDto, partyUrn, dunsNumber, isLegacyRecord);
+                        res.status(201).json(createdCustomer);
+                        return;
+                      } catch (error) {

Contributor

avaitonis Jan 6, 2025

Same question about catch with immediate throw. Maybe this try catch is unnecessary? or does it provide any benefit?

avaitonis reviewed

View reviewed changes

src/modules/customers/customers.service.ts

@@ @@ -22,4 +37,120 @@ export class CustomersService { @@
                     }),
                   );
                 }
+                async getOrCreateCustomer(res: Response, DTFSCustomerDto: DTFSCustomerDto): Promise<GetCustomersResponse> {

Contributor

avaitonis Jan 6, 2025

This function is quite big, can we split it to smaller helpers to avoid too many nested if and try statements

natdeanlewissoftwire force-pushed the create-customer-endpoint-dnb-service branch from f9c18fc to a2f5db5 Compare

January 6, 2025 09:51

natdeanlewissoftwire deleted the branch create-customer-endpoint-dnb-service

January 6, 2025 11:09

natdeanlewissoftwire closed this

This was referenced Jan 6, 2025

feat(FN-3163): automate new DTFS customer creation in Salesforce (D&B service only) #1129

Closed

feat(FN-3163): automate new DTFS customer creation in Salesforce (D&B service only) #1130

Merged

abhi-markan pushed a commit that referenced this pull request


          feat(FN-3163): automate new DTFS customer creation in Salesforce (D&B…

8a6403c

… service only) (#1130)

## Introduction ✏️
As part of the CCM project, if a customer does exist in SF, we are
automatically creating it rather than relying on the manual process
currently undertaken by Business Support Group. DTFS will send requests
to a new customer/salesforce endpoint for MDM to create a customer in
Salesforce. Technical documentation of this process is
[here](https://ukef.sharepoint.com/:w:/r/sites/pmo-PRO211/Shared%20Documents/1.%20TO%20USE%20New%20file%20plan/2.%20Tranche%202/03.%20Customer%20and%20Credit%20Migration/Documents/DTFS%20%26%20Salesforce%20Integration/DTFS%20-%20SF%20Integration%20Technical%20Details.docx?d=w75ec8ca455ec492db2a912cc20cea7e7&csf=1&web=1&e=rhuzKr)

The corresponding feature-flagged DTFS pull request is
[here](UK-Export-Finance/dtfs2#4021)

## Resolution ✔️
This PR adds the Dun and Bradstreet service, and an endpoint to allow us
to GET a company from Dun and Bradstreet by their registration number
(in our case Companies House Number). This will then be used by [this
PR](#1057) as part of
the customer creation process.

## Miscellaneous ➕
To be merged before the remainder of the customer creation endpoint.

Also adds a user facing D&B endpoint, viewable in the Swagger docs:

![image](https://github.com/user-attachments/assets/09829422-4e50-4a81-807e-60651cd099a0)

---------

Co-authored-by: Nat Dean-Lewis <[email protected]>

natdeanlewissoftwire deleted the create-customer-endpoint branch

January 8, 2025 14:42

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet