update window title when the document name changes #1624
+108
−31
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 replaces the document title in the document state with a volatile title property. It also removes the filename from the properties. Both changes are intended to force the CFM to be the source of truth for the title. This change of state should not require a migration of existing v3 documents because the filename/name was already managed by the CFM and just not updated in v3 correctly. To keep the title in sync the filename needs to be processed when the CFM sends the openedFile, savedFile, and renamedFile events.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1624 +/- ##
==========================================
+ Coverage 85.02% 85.52% +0.50%
==========================================
Files 600 601 +1
Lines 30307 30417 +110
Branches 7740 7779 +39
==========================================
+ Hits 25768 26014 +246
+ Misses 4384 4248 -136
Partials 155 155
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
kswenson
approved these changes
Nov 16, 2024
| if (key === "filename") { | ||
| // We don't save the filename because it is redundant with the filename in the actual | ||
| // filesystem. | ||
| // However we need to the extension-less name for the window title |
There was a problem hiding this comment.
Suggested change
| // However we need to the extension-less name for the window title | |
| // However we need the extension-less name for the window title. |
or something like that.
| @@ -42,6 +44,7 @@ class AppState { | |||
| private version = "" | |||
| private cfm: CloudFileManager | undefined | |||
| private dirtyMonitorDisposer: (() => void) | undefined | |||
| titleMonitorDisposer: any | |||
There was a problem hiding this comment.
Suggested change
| titleMonitorDisposer: any | |
| private titleMonitorDisposer: (() => void) | undefined |
| @@ -29,6 +29,7 @@ interface IOptions { | |||
| } | |||
| export function createCodapDocument(snapshot?: ICodapDocumentModelSnapshot, options?: IOptions): IDocumentModel { | |||
| const { layout = "free", noGlobals = false } = options || {} | |||
| // Note: The version and build will not be updated after the document is first created | |||
There was a problem hiding this comment.
Can/should we do something about that? Seems like the expectation would be that it would be the version that most recently saved it.
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.
This replaces the document title in the document state with a volatile title property. It also removes the filename from the properties. Both changes are intended to force the CFM to be the source of truth for the title.
This change of state should not require a migration of existing v3 documents because the filename/name was already managed by the CFM and just not updated in v3 correctly.
To keep the title in sync the filename needs to be processed when the CFM sends the openedFile, savedFile, and renamedFile events.