Skip to content

Commit

Permalink
Clean up names in declarations for workspace state
Browse files Browse the repository at this point in the history
  • Loading branch information
@Viir
Viir committed Mar 24, 2024
1 parent e4a78e1 commit 521e6b4
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 57 deletions.
4 changes: 2 additions & 2 deletions implement/example-apps/elm-editor/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ The workspace link URL we get from the UI contains three components:

The model describing the files in a workspace is optimized for typical training scenarios. Users often enter a workspace with a state as already modeled in a git repository in a subdirectory. Using an URL to a git tree in hosting services like GitHub or GitLab is sufficient to describe the workspace state. The editor then contacts the corresponding git hosting service to load the git repository contents. While loading is in progress, the app displays a message informing about the loading operation.

An example of such an URL to a git tree is <https://github.com/onlinegamemaker/making-online-games/tree/6838f7100dd86c8c8afcfe3efd553f8fa39c77ae/games-program-codes/simple-snake>
An example of such an URL to a git tree is <https://github.com/onlinegamemaker/making-online-games/tree/50a1e1a8c5f6edebfd834016fb609b7baa19954b/games-program-codes/simple-snake>

The corresponding URL into the editor looks like this:
<https://elm-editor.com/?workspace-state=https%3A%2F%2Fgithub.com%2Fonlinegamemaker%2Fmaking-online-games%2Ftree%2F6838f7100dd86c8c8afcfe3efd553f8fa39c77ae%2Fgames-program-codes%2Fsimple-snake>
<https://elm-editor.com/?workspace-state=https%3A%2F%2Fgithub.com%2Fonlinegamemaker%2Fmaking-online-games%2Ftree%2F50a1e1a8c5f6edebfd834016fb609b7baa19954b%2Fgames-program-codes%2Fsimple-snake>

When a user started with a state from a git tree and made some changes, generating a link will encode the workspace state as the difference relative to that git tree. This encoding leads to much smaller URLs. Like in the case of a pure git URL, the editor loads the base from the third-party service. When the loading from git is complete, Elm Editor applies the changes encoded with the URL on top to compute the final file tree.

Expand Down
113 changes: 58 additions & 55 deletions implement/example-apps/elm-editor/src/Frontend/Main.elm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,14 +89,14 @@ type alias State =
{ navigationKey : Navigation.Key
, url : Url.Url
, time : Time.Posix
, workspace : WorkspaceStateStructure
, workspace : WorkspaceStateStruct
, popup : Maybe PopupState
, lastBackendLoadFromGitResult : Maybe ( String, Result (Http.Detailed.Error String) (Result String BackendLoadFromGitOkWithCache) )
}


type WorkspaceStateStructure
= WorkspaceOk WorkspaceOkStruct
type WorkspaceStateStruct
= WorkspaceActive WorkspaceActiveStruct
| WorkspaceLoadingFromLink
{ workspaceStateDescription : WorkspaceState_2021_01.WorkspaceState
, filePathToOpen : Maybe (List String)
Expand All @@ -105,7 +105,7 @@ type WorkspaceStateStructure
| WorkspaceErr String


type alias WorkspaceOkStruct =
type alias WorkspaceActiveStruct =
{ fileTree : FileTreeInWorkspace.FileTreeNode
, editing : { filePathOpenedInEditor : Maybe (List String) }
, decodeMessageFromMonacoEditorError : Maybe Json.Decode.Error
Expand Down Expand Up @@ -396,7 +396,7 @@ update event stateBefore =

UserInputMouseOverTitleBarMenu maybeMenuEntry ->
case stateBefore.workspace of
WorkspaceOk _ ->
WorkspaceActive _ ->
let
fromOpened opened =
maybeMenuEntry |> Maybe.map (\menuEntry -> TitlebarMenu menuEntry opened)
Expand All @@ -423,12 +423,12 @@ update event stateBefore =

UserInputGetLinkToWorkspace generateLink ->
case stateBefore.workspace of
WorkspaceOk workingState ->
WorkspaceActive workspaceActive ->
let
urlToWorkspace =
setWorkspaceStateInUrlForBookmark
{ createDiffIfBaseAvailable = generateLink.createDiffIfBaseAvailable }
workingState
workspaceActive
stateBefore
|> Url.toString

Expand Down Expand Up @@ -501,22 +501,22 @@ update event stateBefore =
, filePathOpenedInEditor = Nothing
}
|> initWorkspaceFromFileTreeAndFileSelection
|> WorkspaceOk
|> WorkspaceActive
}
, urlToPush |> Navigation.pushUrl stateBefore.navigationKey
)

UserInputExportWorkspaceToZipArchive { sendDownloadCmd } ->
case stateBefore.workspace of
WorkspaceOk workingState ->
WorkspaceActive workspaceActive ->
let
cmd =
if sendDownloadCmd then
let
workspaceStateHash =
FileTreeInWorkspace.compositionHashFromFileTreeNode workingState.fileTree
FileTreeInWorkspace.compositionHashFromFileTreeNode workspaceActive.fileTree
in
workingState.fileTree
workspaceActive.fileTree
|> buildZipArchiveFromFileTree
|> Zip.toBytes
|> File.Download.bytes
Expand Down Expand Up @@ -585,7 +585,7 @@ update event stateBefore =

WorkspaceEvent workspaceEvent ->
case stateBefore.workspace of
WorkspaceOk workspaceBefore ->
WorkspaceActive workspaceBefore ->
let
workspaceEventIsEditorGotFocus =
case workspaceEvent of
Expand Down Expand Up @@ -628,7 +628,7 @@ update event stateBefore =
else
Cmd.none
in
( { stateBefore | workspace = WorkspaceOk workspace }
( { stateBefore | workspace = WorkspaceActive workspace }
|> mapForFocusOutsideTitlebarMenu
, [ Cmd.map WorkspaceEvent workspaceCmd
, setWorkspaceStateInUrlCmd
Expand Down Expand Up @@ -713,8 +713,8 @@ userInputFocusOutsideTitlebarMenu stateBefore =
stateBefore


setWorkspaceStateInUrlForBookmark : { createDiffIfBaseAvailable : Bool } -> WorkspaceOkStruct -> State -> Url.Url
setWorkspaceStateInUrlForBookmark { createDiffIfBaseAvailable } workingState state =
setWorkspaceStateInUrlForBookmark : { createDiffIfBaseAvailable : Bool } -> WorkspaceActiveStruct -> State -> Url.Url
setWorkspaceStateInUrlForBookmark { createDiffIfBaseAvailable } workspaceActive state =
let
baseToUse =
if not createDiffIfBaseAvailable then
Expand All @@ -727,9 +727,9 @@ setWorkspaceStateInUrlForBookmark { createDiffIfBaseAvailable } workingState sta
in
state.url
|> Frontend.WorkspaceStateInUrl.setWorkspaceStateInUrl
workingState.fileTree
workspaceActive.fileTree
baseToUse
{ filePathToOpen = workingState.editing.filePathOpenedInEditor }
{ filePathToOpen = workspaceActive.editing.filePathOpenedInEditor }


updateForUserInputLoadFromGit : { time : Time.Posix } -> UserInputLoadFromGitEventStructure -> LoadFromGitDialogState -> ( LoadFromGitDialogState, Cmd Event )
Expand Down Expand Up @@ -775,8 +775,8 @@ updateForUserInputLoadFromGit { time } event dialogStateBefore =
updateWorkspace :
{ time : Time.Posix }
-> WorkspaceEventStructure
-> WorkspaceOkStruct
-> ( WorkspaceOkStruct, Cmd WorkspaceEventStructure )
-> WorkspaceActiveStruct
-> ( WorkspaceActiveStruct, Cmd WorkspaceEventStructure )
updateWorkspace updateConfig event stateBeforeApplyingEvent =
let
( stateBeforeConsiderCompile, cmd ) =
Expand Down Expand Up @@ -876,19 +876,19 @@ updateWorkspace updateConfig event stateBeforeApplyingEvent =
)


filePathOpenedInEditorFromWorkspace : WorkspaceOkStruct -> Maybe (List String)
filePathOpenedInEditorFromWorkspace : WorkspaceActiveStruct -> Maybe (List String)
filePathOpenedInEditorFromWorkspace =
fileOpenedInEditorFromWorkspace >> Maybe.map Tuple.first


fileOpenedInEditorFromWorkspace : WorkspaceOkStruct -> Maybe ( List String, FileTreeInWorkspace.BlobNodeWithCache )
fileOpenedInEditorFromWorkspace workingState =
case workingState.editing.filePathOpenedInEditor of
fileOpenedInEditorFromWorkspace : WorkspaceActiveStruct -> Maybe ( List String, FileTreeInWorkspace.BlobNodeWithCache )
fileOpenedInEditorFromWorkspace workspaceActive =
case workspaceActive.editing.filePathOpenedInEditor of
Nothing ->
Nothing

Just filePathOpenedInEditor ->
case workingState.fileTree |> FileTree.getBlobAtPathFromFileTree filePathOpenedInEditor of
case workspaceActive.fileTree |> FileTree.getBlobAtPathFromFileTree filePathOpenedInEditor of
Nothing ->
Nothing

Expand All @@ -899,8 +899,8 @@ fileOpenedInEditorFromWorkspace workingState =
updateWorkspaceWithoutCmdToUpdateEditor :
{ time : Time.Posix }
-> WorkspaceEventStructure
-> WorkspaceOkStruct
-> ( WorkspaceOkStruct, Cmd WorkspaceEventStructure )
-> WorkspaceActiveStruct
-> ( WorkspaceActiveStruct, Cmd WorkspaceEventStructure )
updateWorkspaceWithoutCmdToUpdateEditor updateConfig event stateBefore =
case event of
UserInputOpenFileInEditor filePath ->
Expand Down Expand Up @@ -1192,8 +1192,8 @@ parseElmFormatResponse response =

provideCompletionItems :
Frontend.MonacoEditor.RequestCompletionItemsStruct
-> WorkspaceOkStruct
-> ( WorkspaceOkStruct, List Frontend.MonacoEditor.MonacoCompletionItem )
-> WorkspaceActiveStruct
-> ( WorkspaceActiveStruct, List Frontend.MonacoEditor.MonacoCompletionItem )
provideCompletionItems request stateBefore =
case stateBefore.editing.filePathOpenedInEditor of
Nothing ->
Expand All @@ -1212,8 +1212,8 @@ provideCompletionItems request stateBefore =

provideHover :
Frontend.MonacoEditor.RequestHoverStruct
-> WorkspaceOkStruct
-> ( WorkspaceOkStruct, List String )
-> WorkspaceActiveStruct
-> ( WorkspaceActiveStruct, List String )
provideHover request stateBefore =
case stateBefore.editing.filePathOpenedInEditor of
Nothing ->
Expand All @@ -1233,8 +1233,8 @@ provideHover request stateBefore =

updateAndGetFromLanguageService :
(LanguageService.LanguageServiceState -> a)
-> WorkspaceOkStruct
-> ( WorkspaceOkStruct, a )
-> WorkspaceActiveStruct
-> ( WorkspaceActiveStruct, a )
updateAndGetFromLanguageService getFromLangService stateBefore =
let
languageServiceState =
Expand All @@ -1257,8 +1257,11 @@ processEventUrlChanged url stateBefore =

workspaceWithMatchingStateHashAlreadyLoaded =
case stateBefore.workspace of
WorkspaceOk workingState ->
Just (Frontend.WorkspaceStateInUrl.workspaceStateCompositionHash (FileTreeInWorkspace.mapBlobsToBytes workingState.fileTree))
WorkspaceActive workspaceActive ->
Just
(Frontend.WorkspaceStateInUrl.workspaceStateCompositionHash
(FileTreeInWorkspace.mapBlobsToBytes workspaceActive.fileTree)
)
== workspaceStateExpectedCompositionHash

_ ->
Expand Down Expand Up @@ -1406,7 +1409,7 @@ updateForLoadedWorkspaceState config loadedBaseWorkspaceState workspaceStateDiff
, filePathOpenedInEditor = config.filePathToOpen
}
|> initWorkspaceFromFileTreeAndFileSelection
|> WorkspaceOk
|> WorkspaceActive
}
|> Ok
in
Expand Down Expand Up @@ -1445,7 +1448,7 @@ fileTreeNodeFromListFileWithPath =
>> FileTreeInWorkspace.sortedFileTreeFromListOfBlobsAsBytes


elmFormatCmdFromState : WorkspaceOkStruct -> Maybe ( String, Cmd WorkspaceEventStructure )
elmFormatCmdFromState : WorkspaceActiveStruct -> Maybe ( String, Cmd WorkspaceEventStructure )
elmFormatCmdFromState state =
case fileOpenedInEditorFromWorkspace state of
Nothing ->
Expand Down Expand Up @@ -1497,7 +1500,7 @@ loadFromGitCmd urlIntoGitRepository =
(Result.map Tuple.second >> BackendLoadFromGitResultEvent urlIntoGitRepository)


compileFileOpenedInEditor : WorkspaceOkStruct -> ( WorkspaceOkStruct, Cmd WorkspaceEventStructure )
compileFileOpenedInEditor : WorkspaceActiveStruct -> ( WorkspaceActiveStruct, Cmd WorkspaceEventStructure )
compileFileOpenedInEditor stateBefore =
case prepareCompileForFileOpenedInEditor stateBefore of
Nothing ->
Expand All @@ -1519,7 +1522,7 @@ compileFileOpenedInEditor stateBefore =
)


syntaxInspectFileOpenedInEditor : WorkspaceOkStruct -> ( WorkspaceOkStruct, Cmd WorkspaceEventStructure )
syntaxInspectFileOpenedInEditor : WorkspaceActiveStruct -> ( WorkspaceActiveStruct, Cmd WorkspaceEventStructure )
syntaxInspectFileOpenedInEditor stateBefore =
case fileOpenedInEditorFromWorkspace stateBefore of
Nothing ->
Expand Down Expand Up @@ -1571,7 +1574,7 @@ requestToBackendCmdFromCompilationInProgress compilation =


prepareCompileForFileOpenedInEditor :
WorkspaceOkStruct
WorkspaceActiveStruct
-> Maybe { requestFromUserIdentity : ElmMakeRequestStructure, compile : () -> CompilationState }
prepareCompileForFileOpenedInEditor workspace =
case workspace.editing.filePathOpenedInEditor of
Expand Down Expand Up @@ -1827,12 +1830,12 @@ view state =
, expectedCompositionHash = expectedCompositionHash
}

WorkspaceOk workingState ->
WorkspaceActive workspaceActive ->
let
workspacePaneLayout paneProperties =
let
widthFillPortion =
if workingState.viewEnlargedPane == Just paneProperties.pane then
if workspaceActive.viewEnlargedPane == Just paneProperties.pane then
40

else
Expand All @@ -1847,7 +1850,7 @@ view state =
, Element.clip
, Element.htmlAttribute (HA.style "flex-shrink" "1")
]
, toggleEnlargedPaneButton workingState paneProperties.pane
, toggleEnlargedPaneButton workspaceActive paneProperties.pane
|> Element.el [ Element.alignTop, Element.alignRight ]
]
|> Element.row
Expand All @@ -1863,7 +1866,7 @@ view state =
]

workspaceView =
case workingState.editing.filePathOpenedInEditor of
case workspaceActive.editing.filePathOpenedInEditor of
Nothing ->
{ editorPaneHeader =
[ Element.text "Choose a file to open in the editor" ]
Expand All @@ -1882,7 +1885,7 @@ view state =
{ selectEventFromNode = selectEventFromFileTreeNode
, iconFromFileName = Visuals.iconFromFileName
}
(sortFileTreeForExplorerView workingState.fileTree)
(sortFileTreeForExplorerView workspaceActive.fileTree)
|> Element.el
[ Element.scrollbars
, Element.width Element.fill
Expand Down Expand Up @@ -1988,7 +1991,7 @@ view state =
]

editorModalOverlay =
case workingState.elmFormat of
case workspaceActive.elmFormat of
Nothing ->
Nothing

Expand Down Expand Up @@ -2096,7 +2099,7 @@ view state =
}

outputPaneElements =
viewOutputPaneContent workingState
viewOutputPaneContent workspaceActive
in
[ [ workspacePaneLayout
{ pane = EditorPane
Expand Down Expand Up @@ -2174,8 +2177,8 @@ view state =

Just (ModalDialog (GetLinkToWorkspaceDialog dialog)) ->
case state.workspace of
WorkspaceOk workingState ->
viewGetLinkToWorkspaceDialog dialog workingState.fileTree
WorkspaceActive workspaceActive ->
viewGetLinkToWorkspaceDialog dialog workspaceActive.fileTree
|> popupWindowElementAttributesFromAttributes

_ ->
Expand All @@ -2187,8 +2190,8 @@ view state =

Just (ModalDialog ExportToZipArchiveDialog) ->
case state.workspace of
WorkspaceOk workingState ->
viewExportToZipArchiveDialog workingState.fileTree
WorkspaceActive workspaceActive ->
viewExportToZipArchiveDialog workspaceActive.fileTree
|> popupWindowElementAttributesFromAttributes

_ ->
Expand Down Expand Up @@ -2374,7 +2377,7 @@ viewFileTreeList =
>> Element.column [ Element.width Element.fill ]


toggleEnlargedPaneButton : WorkspaceOkStruct -> WorkspacePane -> Element.Element WorkspaceEventStructure
toggleEnlargedPaneButton : WorkspaceActiveStruct -> WorkspacePane -> Element.Element WorkspaceEventStructure
toggleEnlargedPaneButton state pane =
let
( icon, onPress ) =
Expand Down Expand Up @@ -2891,7 +2894,7 @@ popupWindowElementAttributesFromAttributes { title, titleIcon, guideParagraphIte


viewOutputPaneContent :
WorkspaceOkStruct
WorkspaceActiveStruct
-> { mainContent : Element.Element WorkspaceEventStructure, header : Element.Element WorkspaceEventStructure }
viewOutputPaneContent state =
case state.syntaxInspection of
Expand Down Expand Up @@ -3013,7 +3016,7 @@ viewOutputPaneContent state =


viewOutputPaneContentFromCompilationComplete :
WorkspaceOkStruct
WorkspaceActiveStruct
-> CompilationState
-> LoweringCompleteStruct
-> Result (Http.Detailed.Error String) ElmMakeResultStructure
Expand Down Expand Up @@ -3719,7 +3722,7 @@ titlebarMenuEntryDropdownContent state menuEntry =
let
canSaveWorkspace =
case state.workspace of
WorkspaceOk _ ->
WorkspaceActive _ ->
True

_ ->
Expand Down Expand Up @@ -3885,7 +3888,7 @@ defaultWorkspaceLink =

initWorkspaceFromFileTreeAndFileSelection :
{ fileTree : FileTreeInWorkspace.FileTreeNode, filePathOpenedInEditor : Maybe (List String) }
-> WorkspaceOkStruct
-> WorkspaceActiveStruct
initWorkspaceFromFileTreeAndFileSelection { fileTree, filePathOpenedInEditor } =
{ fileTree = fileTree
, editing = { filePathOpenedInEditor = filePathOpenedInEditor }
Expand Down

0 comments on commit 521e6b4

Please sign in to comment.