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.

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(profile): change profile api endpoint #4909

Merged
merged 20 commits into from Jan 15, 2021
Merged

feat(profile): change profile api endpoint #4909

merged 20 commits into from Jan 15, 2021

Conversation

annawen1
Copy link
Member

@annawen1 annawen1 commented Jan 14, 2021 •
edited

Related Ticket(s)

Change profile endpoint on Carbon Masthead for signed in state #4701

Description

Change profile endpoint which no longer allows for jsonp to get around CORS errors. Set the new preprod profile endpoint as default.

Changelog

Changed

  • use axios for the profile calls
  • set default host endpoint to preprod url

Removed

  • jsonp package - no longer needed

@annawen1 annawen1 marked this pull request as draft January 14, 2021 21:56
@ibmdotcom-bot
Copy link
Contributor

ibmdotcom-bot commented Jan 14, 2021 •
edited

Deploy preview created for package Web Components - React Wrapper:
https://ibmdotcom-web-components-react.s3-web.us-east.cloud-object-storage.appdomain.cloud/deploy-previews/4909/index.html

Built with commit: d292b39a8f4283a72b1c0337c2689409103d09a1

@ibmdotcom-bot
Copy link
Contributor

ibmdotcom-bot commented Jan 14, 2021 •
edited

Deploy preview created for package React:
https://ibmdotcom-react.s3.us-south.cloud-object-storage.appdomain.cloud/deploy-previews/4909/index.html

Built with commit: d292b39a8f4283a72b1c0337c2689409103d09a1

@jeffchew jeffchew changed the title Feat/change profile api endpoint feat(profile): change profile api endpoint Jan 14, 2021
@jeffchew jeffchew added the package: services Work necessary for the Carbon for IBM.com services package label Jan 14, 2021
@ibmdotcom-bot
Copy link
Contributor

ibmdotcom-bot commented Jan 14, 2021 •
edited

Deploy preview created for package Web Components:
https://ibmdotcom-webcomponents.s3.us-east.cloud-object-storage.appdomain.cloud/deploy-previews/4909/index.html

Built with commit: d292b39a8f4283a72b1c0337c2689409103d09a1

asudoh
asudoh reviewed Jan 14, 2021
View reviewed changes
packages/services-store/src/actions/profileAPI.ts Outdated
Comment on lines 43 to 44
return async dispatch => {
await ProfileAPI.monitorUserStatus((error: Error, status: UserStatus) => {
Copy link
Contributor

@asudoh asudoh Jan 14, 2021 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems that this PR changes ProfileAPI.monitorUserStatus() from a callback-based function to an async function. And thus the call here should be changed accordingly?

Update: Realized that we haven't done such update yet, but I think we should. Given ProfileAPI.monitorUserStatus() is a public API and direct change to there is breaking, we can probably introduce ProfileAPI.getUserStatus().

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh sorry didn't realize we had ProfileAPI.getUserStatus() already... My apologies. In this case, we can rename monitorUserStatus() Redux action to getUserStatus(), change this implementation to use ProfileAPI.getUserStatus() (instead of ProfileAPI.monitorUserStatus()) and change masthead-container.ts and masthead-composite.ts accordingly.

@annawen1 annawen1 marked this pull request as ready for review January 15, 2021 14:54
@ibmdotcom-bot
Copy link
Contributor

ibmdotcom-bot commented Jan 15, 2021 •
edited

Deploy preview created for package "Services":
https://ibmdotcom-services.s3.us-south.cloud-object-storage.appdomain.cloud/deploy-previews/4909/index.html

Built with commit: d292b39a8f4283a72b1c0337c2689409103d09a1

jeffchew
jeffchew approved these changes Jan 15, 2021
View reviewed changes
Copy link
Member

@jeffchew jeffchew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@jeffchew jeffchew added the Ready to merge Label for the pull requests that are ready to merge label Jan 15, 2021
@kodiakhq kodiakhq bot merged commit e9cffaa into carbon-design-system:master Jan 15, 2021
asudoh
asudoh reviewed Jan 16, 2021
View reviewed changes
Copy link
Contributor

@asudoh asudoh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the work @annawen1!

packages/services-store/src/actions/profileAPI.ts Show resolved Hide resolved
packages/services-store/src/actions/__tests__/profileAPI.test.ts
// it('dispatches the action to get user authentication status', async () => {
// ProfileAPI.getUserStatus.mockResolvedValue({ user: 'Unauthenticated' });
// const store = mockStore();
// await store.dispatch(ProfileAPI.getUserStatus());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of ProfileAPI.getUserStatus() (that makes a call to @carbon/ibmdotcom-services module), we need to call a Redux action here. Here is a test in this category for reference: https://github.com/carbon-design-system/carbon-for-ibm-dotcom/blob/v1.14.0/packages/services-store/src/actions/__tests__/localeAPI.test.ts#L84

packages/services-store/src/actions/__tests__/profileAPI.test.ts Show resolved Hide resolved
packages/web-components/src/components/masthead/masthead-composite.ts Show resolved Hide resolved
packages/web-components/src/components/masthead/masthead-composite.ts Show resolved Hide resolved
packages/services-store/src/actions/profileAPI.ts Show resolved Hide resolved
@jeffchew jeffchew mentioned this pull request Jan 19, 2021
Closed
@annawen1 annawen1 mentioned this pull request Jan 19, 2021
Merged
kodiakhq bot pushed a commit that referenced this pull request Jan 20, 2021
@annawen1
fix(profile): update profile requx actions, types, and reducers namin…
c824634 
…g and unit tests (#4926)

### Related Ticket(s)

Change profile endpoint on Carbon Masthead for signed in state #4701

### Description

Update naming and unit tests from feedback: #4909

### Changelog

**Changed**

- update `getUserStatus` action to `loadUserStatus` in accordance to naming strategy
- create `Unauthenticated` const in ProfileAPI type
- use `request` instead of `status` for the `setRequestUserStatusInProgress` and `setUserStatus` actions

<!-- React and Web Component deploy previews are enabled by default. -->
<!-- To enable additional available deploy previews, apply the following -->
<!-- labels for the corresponding package: -->
<!-- *** "package: services": Services -->
<!-- *** "package: utilities": Utilities -->
<!-- *** "package: styles": Carbon Expressive -->
<!-- *** "RTL": React / Web Components (RTL) -->
<!-- *** "feature flag": React / Web Components (experimental) -->
@annawen1 annawen1 deleted the feat/change-profile-api-endpoint branch February 10, 2021 18:19
IgnacioBecerra pushed a commit to IgnacioBecerra/ibm-dotcom-library that referenced this pull request Feb 22, 2021
@annawen1 @IgnacioBecerra
feat(profile): change profile api endpoint (carbon-design-system#4909)
09c6b09 
### Related Ticket(s)

Change profile endpoint on Carbon Masthead for signed in state carbon-design-system#4701

### Description

Change profile endpoint which no longer allows for jsonp to get around CORS errors. Set the new preprod profile endpoint as default. 

### Changelog

**Changed**

- use `axios` for the profile calls
- set default host endpoint to preprod url

**Removed**

- `jsonp` package - no longer needed

<!-- React and Web Component deploy previews are enabled by default. -->
<!-- To enable additional available deploy previews, apply the following -->
<!-- labels for the corresponding package: -->
<!-- *** "package: services": Services -->
<!-- *** "package: utilities": Utilities -->
<!-- *** "package: styles": Carbon Expressive -->
<!-- *** "RTL": React / Web Components (RTL) -->
<!-- *** "feature flag": React / Web Components (experimental) -->
IgnacioBecerra pushed a commit to IgnacioBecerra/ibm-dotcom-library that referenced this pull request Feb 22, 2021
@annawen1 @IgnacioBecerra
fix(profile): update profile requx actions, types, and reducers namin…
2545a46 
…g and unit tests (carbon-design-system#4926)

### Related Ticket(s)

Change profile endpoint on Carbon Masthead for signed in state carbon-design-system#4701

### Description

Update naming and unit tests from feedback: carbon-design-system#4909

### Changelog

**Changed**

- update `getUserStatus` action to `loadUserStatus` in accordance to naming strategy
- create `Unauthenticated` const in ProfileAPI type
- use `request` instead of `status` for the `setRequestUserStatusInProgress` and `setUserStatus` actions

<!-- React and Web Component deploy previews are enabled by default. -->
<!-- To enable additional available deploy previews, apply the following -->
<!-- labels for the corresponding package: -->
<!-- *** "package: services": Services -->
<!-- *** "package: utilities": Utilities -->
<!-- *** "package: styles": Carbon Expressive -->
<!-- *** "RTL": React / Web Components (RTL) -->
<!-- *** "feature flag": React / Web Components (experimental) -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@asudoh asudoh asudoh left review comments

@jeffchew jeffchew jeffchew approved these changes

@kennylam kennylam Awaiting requested review from kennylam

Assignees
No one assigned
Labels
package: services Work necessary for the Carbon for IBM.com services package Ready to merge Label for the pull requests that are ready to merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@annawen1 @ibmdotcom-bot @asudoh @jeffchew