-
Notifications
You must be signed in to change notification settings - Fork 3k
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
#30468 parse supported timezone #33186
#30468 parse supported timezone #33186
Conversation
@sobitneupane Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button] |
Yes It works I also capture in Screenshots/Videos section |
Hi @sobitneupane have you got any feedback on my PR |
() => | ||
accountPersonalDetails | ||
? {...accountPersonalDetails, accountID, timezone: accountPersonalDetails.timezone ? DateUtils.parseTimezone(accountPersonalDetails.timezone) : undefined} | ||
: {}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@suneox Can you please help me understand the reason for this change. I think we should change the timezone to supported format before saving it to Onyx. Is there any possible scenario where personalDetails
retrieved from storage has unsupported timezone?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change to handle case user has save the timezone is not supported to BE and user do not anything action to re-update timezone. So when get the timezone from BE we also should parse to supported timezone to display
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @suneox for the prompt reply.
user has save the timezone is not supported to BE and user do not anything action to re-update timezone.
I didn't get you. Can you please add more details. User saved timezone will be from the list of TIMEZONES.ts
, right? Will there be any case where the saved timezone is not supported by BE? Please let me know if I am missing something.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That mean a user has saved an unsupported timezone to BE by set Automatically Timezone
BEFORE merge this PR and this timezone not available in the list of TIMEZONES.ts, so this change to support return supported timezone from currentUserPersonalDetails
if user do not change timezone after merge this PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we need to consider the situation as we are still in development phase and the issue was not reported before. So, I think we are safe to remove the change. Please let me know if you disagree.
src/libs/DateUtils.ts
Outdated
* function parse timezone to supported timezone | ||
* @returns Timezone | ||
*/ | ||
function parseTimezone(timezoneInput: Timezone): Timezone { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should name it formatToSupportedTimezone
or convertToSupportedTimezone
?
src/libs/actions/PersonalDetails.ts
Outdated
@@ -296,7 +297,7 @@ function updateAutomaticTimezone(timezone: Timezone) { | |||
}; | |||
|
|||
const parameters: UpdateAutomaticTimezoneParams = { | |||
timezone: JSON.stringify(timezone), | |||
timezone: JSON.stringify(DateUtils.parseTimezone(timezone)), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like you have not updated the timezone saved in Onyx.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes I have missed let me update
Prepare:
Reproduce Step:
trim.80B223C7-DCFF-47C7-A71C-FDD95C780B75.MOV |
I have updated code review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am still seeing the issue @suneox
Screen.Recording.2023-12-21.at.13.43.43.mov
Some issues:
- Timezone is switching between unformatted and formatted timezone when user toggles 'automatically determine location'
- Timezone resets back to unformatted timezone.
Hi @sobitneupane So let me also update an api |
Hi @sobitneupane 30468_3.mp4 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewer Checklist
- I have verified the author checklist is complete (all boxes are checked off).
- I verified the correct issue is linked in the
### Fixed Issues
section above - I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the
Tests
section - I verified the steps for Staging and/or Production testing are in the
QA steps
section - I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I verified the steps for local testing are in the
- I checked that screenshots or videos are included for tests on all platforms
- I included screenshots or videos for tests on all platforms
- I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
- If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
- I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e.
toggleReport
and notonIconClick
). - I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g.
myBool && <MyComponent />
. - I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to
src/languages/*
files and using the translation method - I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the
Waiting for Copy
label for a copy review on the original GH to get the correct copy. - I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in
STYLE.md
) were followed
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e.
- If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
- I verified that this PR follows the guidelines as stated in the Review Guidelines
- I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like
Avatar
, I verified the components usingAvatar
have been tested & I retested again) - I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
- I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
- If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a
/** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to
this
properly so there are no scoping issues (i.e. foronClick={this.submit}
the methodthis.submit
should be bound tothis
in the constructor) - Any internal methods bound to
this
are necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);
ifthis.submit
is never passed to a component event handler likeonClick
) - All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
- If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
- If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e.
StyleUtils.getBackgroundAndBorderStyle(theme.componentBG
)
- If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
- If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like
Avatar
is modified, I verified thatAvatar
is working as expected in all cases) - If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
- If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
- If the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added
Design
label so the design team can review the changes.
- If a new page is added, I verified it's using the
ScrollView
component to make it scrollable when more elements are added to the page. - If the
main
branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTest
steps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
Screenshots/Videos
Android: Native
Screen.Recording.2023-12-22.at.10.39.51.mov
Android: mWeb Chrome
iOS: Native
Screen.Recording.2023-12-22.at.09.56.29.mov
iOS: mWeb Safari
Screen.Recording.2023-12-22.at.09.10.49.mov
MacOS: Chrome / Safari
Screen.Recording.2023-12-22.at.08.35.35.mov
MacOS: Desktop
Screen.Recording.2023-12-22.at.08.48.45.mov
Hi, @amyevans |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your patience while I was OOO. Just one change requested!
@@ -419,3 +420,133 @@ export default [ | |||
'Pacific/Wake', | |||
'Pacific/Wallis', | |||
] as const; | |||
|
|||
const timezoneBackwardMap: Record<string, (typeof TIMEZONES)[number]> = { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you add a comment explaining briefly where these values come from (link to wikipedia page)/what the purpose of the map is? That way people curious in the future don't have to follow the GH blame trail.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple suggestions regarding the comments, let me know if they make sense or if we should continue to refine.
src/TIMEZONES.ts
Outdated
@@ -419,3 +420,137 @@ export default [ | |||
'Pacific/Wake', | |||
'Pacific/Wallis', | |||
] as const; | |||
|
|||
/** | |||
* On some devices the timezone backward doesn't support so when a user using multiple devices has automatic timezone setting will not display in the list timezone selection |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* On some devices the timezone backward doesn't support so when a user using multiple devices has automatic timezone setting will not display in the list timezone selection | |
The timezones supported in browser and on native devices differ, so we must map each timezone to its supported equivalent. |
src/TIMEZONES.ts
Outdated
|
||
/** | ||
* On some devices the timezone backward doesn't support so when a user using multiple devices has automatic timezone setting will not display in the list timezone selection | ||
* List timezone backward parse from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* List timezone backward parse from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones | |
* Data sourced from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
@amyevans Your the comment suggestion is better than mine so I have updated it |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
The only remaining thing is the author checklist check is failing, looks like the template was updated recently: https://github.com/Expensify/App/pull/30699/files. @suneox Could you update your checklist to include those new checks please?
@amyevans the current code change doesn't update any style and I have updated the checklist |
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
🚀 Deployed to staging by https://github.com/amyevans in version: 1.4.23-0 🚀
|
🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.23-4 🚀
|
Details
Fixed Issues
$ #30468
PROPOSAL: #30468 (comment)
Tests
Preconditions: simulate location or change timezone to Ukraine
Europe/Kiev
location then turn on sensorOffline tests
QA Steps
Preconditions: simulate location or change timezone to Ukraine
Europe/Kiev
location then turn on sensorPR Author Checklist
### Fixed Issues
section aboveTests
sectionOffline steps
sectionQA steps
sectiontoggleReport
and notonIconClick
)myBool && <MyComponent />
.src/languages/*
files and using the translation methodWaiting for Copy
label for a copy review on the original GH to get the correct copy.STYLE.md
) were followedAvatar
, I verified the components usingAvatar
are working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
)Avatar
is modified, I verified thatAvatar
is working as expected in all cases)Design
label so the design team can review the changes.ScrollView
component to make it scrollable when more elements are added to the page.main
branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTest
steps.Screenshots/Videos
MacOS: Desktop
desktop.mp4
Android: mWeb Chrome
android-chrome.mp4
Android: Native
iOS: mWeb Safari
ios-safari.MP4
iOS: Native
ios-native.mp4
MacOS: Chrome / Safari
web-chrome.mp4