Add System.OsPath.Extra to buck-worker-types

Author: Copilot

ghc-server/lib/GhcServer/Path.hs

@@ -1,24 +1,8 @@
 -- | Path utilities shared across GHC server modules.
-module GhcServer.Path where
+module GhcServer.Path (fromOsPath, toOsPath, outputDirName, tmpDirName, socketDirName, socketPath) where
 
-import Control.Exception (Exception, SomeException, throw)
-import System.OsPath (OsPath, decodeUtf, encodeUtf, (</>))
-
-data PathDecodingException = PathDecodingException OsPath SomeException
-  deriving stock (Show)
-
-instance Exception PathDecodingException where
-
-data PathEncodingException = PathEncodingException FilePath SomeException
-  deriving stock (Show)
-
-instance Exception PathEncodingException where
-
-fromOsPath :: OsPath -> FilePath
-fromOsPath p = either (throw . PathDecodingException p) id (decodeUtf p)
-
-toOsPath :: String -> OsPath
-toOsPath p = either (throw . PathEncodingException p) id (encodeUtf p)
+import System.OsPath (OsPath, (</>))
+import System.OsPath.Extra (fromOsPath, toOsPath)
 
 -- | Directory names under the project root for server artifacts.
 outputDirName, tmpDirName, socketDirName :: OsPath

types/buck-worker-types.cabal

@@ -50,6 +50,7 @@ library
     Types.State.Oneshot
     Types.State.Stats
     Types.Target
+    System.OsPath.Extra
   build-depends:
     aeson,
     base ==4.*,

types/src/System/OsPath/Extra.hs

@@ -0,0 +1,24 @@
+module System.OsPath.Extra where
+
+import Control.Exception (Exception, SomeException, throw)
+import System.OsPath (OsPath, decodeUtf, encodeUtf)
+
+data OsPathDecodingException = OsPathDecodingException OsPath SomeException
+  deriving stock (Show)
+
+instance Exception OsPathDecodingException where
+
+data OsPathEncodingException = OsPathEncodingException String SomeException
+  deriving stock (Show)
+
+instance Exception OsPathEncodingException where
+
+-- | Like 'decodeUtf' but throws an exception instead of returning an Either
+-- and the exception provides the filepath as context.
+fromOsPath :: OsPath -> String
+fromOsPath p = either (throw . OsPathDecodingException p) id (decodeUtf p)
+
+-- | Like 'encodeUtf' but throws an exception instead of returning an Either
+-- and the exception provides the filepath as context.
+toOsPath :: String -> OsPath
+toOsPath p = either (throw . OsPathEncodingException p) id (encodeUtf p)