TypeScript: Convert pageDataUrls provider
#12727
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This pull request introduces 1 alert when merging 0078336 into d01beaa - view on LGTM.com new alerts:
Heads-up: LGTM.com's PR analysis will be disabled on the 5th of December, and LGTM.com will be shut down ⏻ completely on the 16th of December 2022. Please enable GitHub code scanning, which uses the same CodeQL engine ⚙️ that powers LGTM.com. For more information, please check out our post on the GitHub blog. |
packages/story-editor/src/app/pageDataUrls/pageDataUrlsProvider.tsx
Outdated
Show resolved
Hide resolved
timarney
added
Package: Design System
|
Plugin builds for fba8475 are ready 🛎️!
|
|
Size Change: +18 B (0%) Total Size: 2.71 MB ℹ️ View Unchanged
|
swissspidy
reviewed
Dec 1, 2022
packages/story-editor/src/app/pageDataUrls/pageDataUrlsProvider.tsx
Outdated
Show resolved
Hide resolved
swissspidy
changed the title
pageDataUrls provider
miina
added
Pod: Prometheus
and removed
Status: Blocked
miina
requested review from
swissspidy and
barklund
and removed request for
barklund
miina
reviewed
Jan 2, 2023
tests/js/jest.config.js
Outdated
| @@ -44,7 +44,7 @@ export default { | |||
| // See https://jestjs.io/docs/configuration#transformignorepatterns-arraystring | |||
| transformIgnorePatterns: ['/node_modules/(?!(use-reduction)/)'], | |||
| testEnvironment: 'jsdom', | |||
| testMatch: ['**/test/**/*.[jt]s'], | |||
| testMatch: ['**/test/**/*.[jt]s?(x)'], | |||
There was a problem hiding this comment.
Due to enabling .tsx files, the following tests are now failing:
https://github.com/GoogleForCreators/web-stories-wp/actions/runs/3824643543/jobs/6506964376#step:9:286
Thoughts @barklund @swissspidy?
Since it's not related to this PR, I'll just revert it back, however, these need to get fixes.
Created an issue for it: #12895 12895
barklund
approved these changes
Jan 5, 2023
packages/design-system/tsconfig.json
Outdated
| @@ -19,6 +19,7 @@ | |||
| "src/types/*", | |||
| "src/types.ts", | |||
| "src/utils/*.ts", | |||
| "src/utils/*.tsx", | |||
There was a problem hiding this comment.
Why this change if this PR doesn't actually contain any files from the design system?
There was a problem hiding this comment.
Huh, not sure. I took this PR over, perhaps there was a .tsx file originally that was not needed anymore 🤔
Will remove this.
| function PageDataUrlProvider({ children }) { | ||
| const [dataUrls, setDataUrls] = useState({}); | ||
| function PageDataUrlProvider({ children }: PropsWithChildren<unknown>) { | ||
| const [dataUrls, setDataUrls] = useState<PageDataUrlsState['dataUrls']>({}); |
There was a problem hiding this comment.
Not a big fan of this notation here. I'd rather we just made separate types for these and used those types in the state as well.
There was a problem hiding this comment.
(also because the state only contains this one single prop)
Comment on lines
22
to
33
| export interface PageDataUrlsState { | ||
| dataUrls: Record<string, string>; | ||
| } | ||
|
|
||
| export interface PageDataUrlsActions { | ||
| queuePageImageGeneration: (Page: Page) => void; | ||
| } | ||
|
|
||
| export interface PageDataUrlsContext { | ||
| state: PageDataUrlsState; | ||
| actions: PageDataUrlsActions; | ||
| } |
There was a problem hiding this comment.
So this would be:
export type PageDataUrls = Record<string, string>;
export type QueuePageImageGeneration: (page: Page) => void;
export interface PageDataUrlsContext {
state: { dataUrls: PageDataUrls }
actions: { queuePageImageGeneration: QueuePageImageGeneration};
}| @@ -24,7 +24,7 @@ const requestIdleCallback = | |||
| return setTimeout(() => { | |||
| callback({ | |||
| get didTimeout() { | |||
| return options.timeout | |||
| return typeof options.timeout !== 'undefined' | |||
There was a problem hiding this comment.
'timeout' in options is a bit cleaner.
There was a problem hiding this comment.
If options.timeout is undefined but set, 'options' in timeout would give true though.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
Summary
Relevant Technical Choices
To-do
User-facing changes
Testing Instructions
This PR can be tested by following these steps:
Reviews
Does this PR have a security-related impact?
No
Does this PR change what data or activity we track or use?
No
Does this PR have a legal-related impact?
No
Checklist
Type: XYZlabel to the PRFixes #12668