-
Notifications
You must be signed in to change notification settings - Fork 241
#9780 - Save the polymer type switcher (RNA/DNA/PEP) to browser cache #10148
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
Open
mariam-khutuashvili
wants to merge
2
commits into
master
Choose a base branch
from
9780-save-the-polymer-type-switcher-rna-dna-pep-to-browser-cache
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+91
−4
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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
46 changes: 46 additions & 0 deletions
46
packages/ketcher-macromolecules/src/helpers/sequenceTypeStorage.test.ts
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| import { KetcherLogger, SequenceType } from 'ketcher-core'; | ||
| import { SEQUENCE_TYPE_STORAGE_KEY } from 'src/constants'; | ||
| import { | ||
| getPersistedSequenceType, | ||
| persistSequenceType, | ||
| } from './sequenceTypeStorage'; | ||
|
|
||
| describe('sequenceTypeStorage', () => { | ||
| afterEach(() => { | ||
| window.localStorage.clear(); | ||
| }); | ||
|
|
||
| it('defaults to RNA when nothing is persisted', () => { | ||
| expect(getPersistedSequenceType()).toBe(SequenceType.RNA); | ||
| }); | ||
|
|
||
| it('persists and restores the selected polymer type', () => { | ||
| persistSequenceType(SequenceType.PEPTIDE); | ||
| expect(getPersistedSequenceType()).toBe(SequenceType.PEPTIDE); | ||
|
|
||
| persistSequenceType(SequenceType.DNA); | ||
| expect(getPersistedSequenceType()).toBe(SequenceType.DNA); | ||
| }); | ||
|
|
||
| it('falls back to RNA when the stored value is invalid', () => { | ||
| window.localStorage.setItem( | ||
| SEQUENCE_TYPE_STORAGE_KEY, | ||
| JSON.stringify('NOT_A_TYPE'), | ||
| ); | ||
| expect(getPersistedSequenceType()).toBe(SequenceType.RNA); | ||
| }); | ||
|
|
||
| it('falls back to RNA when the stored value is malformed JSON', () => { | ||
| const loggerSpy = jest | ||
| .spyOn(KetcherLogger, 'error') | ||
| .mockImplementation(() => undefined); | ||
| // Raw, non-JSON string (bypassing JSON.stringify) simulates a corrupted or | ||
| // manually-edited value that makes JSON.parse throw inside getItem. | ||
| window.localStorage.setItem(SEQUENCE_TYPE_STORAGE_KEY, 'not-json{'); | ||
|
|
||
| expect(getPersistedSequenceType()).toBe(SequenceType.RNA); | ||
| expect(loggerSpy).toHaveBeenCalled(); | ||
|
|
||
| loggerSpy.mockRestore(); | ||
| }); | ||
| }); |
31 changes: 31 additions & 0 deletions
31
packages/ketcher-macromolecules/src/helpers/sequenceTypeStorage.ts
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| import { KetcherLogger, SequenceType } from 'ketcher-core'; | ||
| import { localStorageWrapper } from './localStorage'; | ||
| import { SEQUENCE_TYPE_STORAGE_KEY } from '../constants'; | ||
|
|
||
| const isSequenceType = (value: unknown): value is SequenceType => | ||
| value === SequenceType.RNA || | ||
| value === SequenceType.DNA || | ||
| value === SequenceType.PEPTIDE; | ||
|
|
||
| // Read the last polymer type chosen on the sequence-type switcher from | ||
| // localStorage, falling back to RNA when nothing valid is stored (#9780). | ||
| // `localStorageWrapper.getItem` runs `JSON.parse`, which throws on a malformed | ||
| // value (manual edit / partial write), so the read is guarded to avoid | ||
| // crashing the switcher's mount effect. | ||
| export const getPersistedSequenceType = (): SequenceType => { | ||
| let stored: unknown; | ||
| try { | ||
| stored = localStorageWrapper.getItem(SEQUENCE_TYPE_STORAGE_KEY); | ||
| } catch (error) { | ||
| KetcherLogger.error( | ||
| 'sequenceTypeStorage.ts::getPersistedSequenceType', | ||
| error, | ||
| ); | ||
| return SequenceType.RNA; | ||
| } | ||
| return isSequenceType(stored) ? stored : SequenceType.RNA; | ||
| }; | ||
|
mariam-khutuashvili marked this conversation as resolved.
|
||
|
|
||
| export const persistSequenceType = (sequenceType: SequenceType): void => { | ||
| localStorageWrapper.setItem(SEQUENCE_TYPE_STORAGE_KEY, sequenceType); | ||
| }; | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.