diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Revision history for pms-application-service + +## 0.0.1.0 -- 2025-05-31 + +* First version. diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# pms-application-service + +[`pty-mcp-server`](https://github.com/phoityne/pty-mcp-server) is a multi-threaded application designed to handle multiple domain-specific tasks concurrently. +`pms-application-service` is one of its internal packages, responsible for coordinating core application logic and managing concurrent execution across threads. + +This package interprets user-intent commands (parsed from JSON-RPC requests) and executes them within specific domain contexts. +It bridges structured input from the UI layer with the infrastructure layer's effectful operations, ensuring that requests are processed in a deterministic and decoupled manner. + +In addition to command dispatching, `pms-application-service` manages the lifecycle of domain-aware applications and supervises their execution threads. +It provides the orchestration required to safely run multiple applications in parallel, maintaining responsiveness and isolation across concurrent tasks. + +--- + +## Package Structure +![Package Structure](https://raw.githubusercontent.com/phoityne/pms-application-service/main/docs/31-1.png) +--- + +## Module Structure +![Module Structure](https://raw.githubusercontent.com/phoityne/pms-application-service/main/docs/31-2.png) + + +--- diff --git a/pms-application-service.cabal b/pms-application-service.cabal new file mode 100644 --- /dev/null +++ b/pms-application-service.cabal @@ -0,0 +1,133 @@ +cabal-version: 3.12 +-- The cabal-version field refers to the version of the .cabal specification, +-- and can be different from the cabal-install (the tool) version and the +-- Cabal (the library) version you are using. As such, the Cabal (the library) +-- version used must be equal or greater than the version stated in this field. +-- Starting from the specification version 2.2, the cabal-version field must be +-- the first thing in the cabal file. + +-- Initial package description 'pms-application-service' generated by +-- 'cabal init'. For further documentation, see: +-- http://haskell.org/cabal/users-guide/ +-- +-- The name of the package. +name: pms-application-service + +-- The package version. +-- See the Haskell package versioning policy (PVP) for standards +-- guiding when and how versions should be incremented. +-- https://pvp.haskell.org +-- PVP summary: +-+------- breaking API changes +-- | | +----- non-breaking API additions +-- | | | +--- code changes with no API change +version: 0.0.1.0 + +-- A short (one-line) description of the package. +synopsis: pms-application-service + +-- A longer description of the package. +description: README.md + +-- The license under which the package is released. +license: Apache-2.0 + +-- The file containing the license text. +license-file: LICENSE + +-- The package author(s). +author: phoityne.hs@gmail.com + +-- An email address to which users can send suggestions, bug reports, and patches. +maintainer: phoityne.hs@gmail.com + +-- A copyright notice. +copyright: 2025-2026 phoityne.hs@gmail.com +category: AI +build-type: Simple +homepage: https://github.com/phoityne/pms-application-service +bug-reports: https://github.com/phoityne/pms-application-service/issues + +-- Extra doc files to be distributed with the package, such as a CHANGELOG or a README. +extra-doc-files: README.md, + CHANGELOG.md + +-- Extra source files to be distributed with the package, such as examples, or a tutorial module. +-- extra-source-files: + + +library + -- Import common warning flags. + ghc-options: -Wall -Wno-x-partial + + -- Modules exported by the library. + exposed-modules: PMS.Application.Service.DM.Type, + PMS.Application.Service.DM.Constant, + PMS.Application.Service.App.Control, + PMS.Application.Service.DS.Core, + PMS.Application.Service.DS.Utility + + + -- Modules included in this library but not exported. + -- other-modules: Paths_pms_application_service + + -- LANGUAGE extensions used by modules in this package. + -- other-extensions: + + -- Other library packages from which modules are imported. + build-depends: base ^>=4.21.0.0, + aeson, + lens, + data-default, + fast-logger, + monad-logger, + safe-exceptions, + yaml, + text, + mtl, + async, + async-pool, + pms-domain-model + + -- Directories containing source files. + hs-source-dirs: src + + -- Base language which the package is written in. + default-language: GHC2021 + default-extensions: LambdaCase + +test-suite pms-application-service-test + -- Import common warning flags. + ghc-options: -Wall -Wno-x-partial + + -- Base language which the package is written in. + default-language: GHC2021 + + -- Modules included in this executable, other than Main. + other-modules: PMS.Application.Service.App.ControlSpec + + -- LANGUAGE extensions used by modules in this package. + -- other-extensions: + + -- The interface type and version of the test suite. + type: exitcode-stdio-1.0 + + -- Directories containing source files. + hs-source-dirs: test + + -- The entrypoint to the test suite. + main-is: Spec.hs + + -- Test dependencies. + build-depends: base ^>=4.21.0.0, + hspec, + hspec-discover, + data-default, + stm, + monad-logger, + async, + unix, + lens, + pms-domain-model, + pms-application-service + build-tool-depends: + hspec-discover:hspec-discover diff --git a/src/PMS/Application/Service/App/Control.hs b/src/PMS/Application/Service/App/Control.hs new file mode 100644 --- /dev/null +++ b/src/PMS/Application/Service/App/Control.hs @@ -0,0 +1,75 @@ +{-# LANGUAGE LambdaCase #-} + +module PMS.Application.Service.App.Control where + +import qualified Control.Exception.Safe as E +import Data.Default +import Data.Yaml +import Control.Lens +import System.Log.FastLogger +import System.IO + +import qualified PMS.Domain.Model.DM.Type as DM +import qualified PMS.Domain.Model.DS.Utility as DM + +import PMS.Application.Service.DM.Type +import PMS.Application.Service.DS.Utility +import PMS.Application.Service.DS.Core +import PMS.Application.Service.DM.Constant + + +-- | +-- +run :: ArgData + -> [DM.DomainContext ()] + -> IO () +run args apps = do + hPutStrLn stderr "[INFO] PMS.Application.Service.App.Control.run called." + + conf <- maybe (pure def) decodeFileThrow (args^.yamlArgData) + defDom <- DM.defaultDomainData + + hPutStrLn stderr $ "[INFO] PMS.Application.Service.App.Control.run conf." ++ show conf + + let domDat = defDom { + DM._logDirDomainData = conf^.logDirConfigData + , DM._logLevelDomainData = conf^.logLevelConfigData + , DM._scriptsDirDomainData = conf^.scriptsDirConfigData + , DM._promptsDomainData = conf^.promptsConfigData + } + appDat = def { + _appsAppData = apps + } + DM.createLogger domDat _LOG_FILE_NAME >>= runWithLogger domDat appDat + + +-- | +-- +runWithLogger :: DM.DomainData -> AppData -> (TimedFastLogger, IO ()) -> IO () +runWithLogger domDat appDat (logger, finalizeLogger) = + flip E.catchAny exception + $ flip E.finally finalize + $ runApp domDat appDat logger app + >>= \case + Right _ -> return () + Left e -> errorEnd e + + where + finalize = do + hPutStrLn stderr "-----------------------------------------------------------------------------" + hPutStrLn stderr "[INFO] PMS.Application.Service.App.Control.run finalize called." + finalizeLogger + hPutStrLn stderr "-----------------------------------------------------------------------------" + + exception e = do + hPutStrLn stderr "-----------------------------------------------------------------------------" + hPutStrLn stderr "[ERROR] PMS.Application.Service.App.Control.run exception occurred." + hPutStrLn stderr $ show e + hPutStrLn stderr "-----------------------------------------------------------------------------" + E.throwIO e + + errorEnd e = do + hPutStrLn stderr "-----------------------------------------------------------------------------" + hPutStrLn stderr "[ERROR] PMS.Application.Service.App.Control.run end with error." + hPutStrLn stderr $ show e + hPutStrLn stderr "-----------------------------------------------------------------------------" diff --git a/src/PMS/Application/Service/DM/Constant.hs b/src/PMS/Application/Service/DM/Constant.hs new file mode 100644 --- /dev/null +++ b/src/PMS/Application/Service/DM/Constant.hs @@ -0,0 +1,10 @@ +module PMS.Application.Service.DM.Constant where + + +-------------------------------------------------------------------------------- +-- | +-- +_LOG_FILE_NAME :: String +_LOG_FILE_NAME = "pms-application-service.log" + + diff --git a/src/PMS/Application/Service/DM/Type.hs b/src/PMS/Application/Service/DM/Type.hs new file mode 100644 --- /dev/null +++ b/src/PMS/Application/Service/DM/Type.hs @@ -0,0 +1,84 @@ +{-# LANGUAGE TemplateHaskell #-} + + +module PMS.Application.Service.DM.Type where + +import Data.Data +import Data.Default +import Control.Lens +import Data.Aeson +import Data.Aeson.TH +import Control.Monad.Logger +import Control.Monad.Reader +import Control.Monad.Except + +import qualified PMS.Domain.Model.DM.Type as DM + + +-------------------------------------------------------------------------------- +-- | +-- +data ArgData = ArgData { + _yamlArgData :: Maybe FilePath + } deriving (Data, Show, Read, Eq) + +makeLenses ''ArgData +$(deriveJSON + defaultOptions { + fieldLabelModifier = tail . reverse . drop (length "ArgData") . reverse + } + ''ArgData) + +instance Default ArgData where + def = ArgData { + _yamlArgData = Nothing + } + + +-------------------------------------------------------------------------------- +-- | +-- +data ConfigData = ConfigData { + _logDirConfigData :: Maybe FilePath + , _logLevelConfigData :: LogLevel + , _scriptsDirConfigData :: FilePath + , _promptsConfigData :: [String] + } deriving (Show, Read, Eq) + +makeLenses ''ConfigData +$(deriveJSON + defaultOptions { + fieldLabelModifier = tail . reverse . drop (length "ConfigData") . reverse + } + ''ConfigData) + +instance Default ConfigData where + def = ConfigData { + _logDirConfigData = Nothing + , _logLevelConfigData = LevelDebug + , _scriptsDirConfigData = "./scripts" + , _promptsConfigData = [ + "ghci>" + , "]$" + , ")?" + , "password:" + ] + } + + +-------------------------------------------------------------------------------- +-- | +-- +data AppData = AppData { + _appsAppData :: [DM.DomainContext ()] + } +instance Default AppData where + def = AppData { + _appsAppData = [] + } + +makeLenses ''AppData + +-- | +-- +type AppContext = ReaderT AppData (ReaderT DM.DomainData (ExceptT DM.ErrorData (LoggingT IO))) diff --git a/src/PMS/Application/Service/DS/Core.hs b/src/PMS/Application/Service/DS/Core.hs new file mode 100644 --- /dev/null +++ b/src/PMS/Application/Service/DS/Core.hs @@ -0,0 +1,50 @@ +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE OverloadedStrings #-} + +module PMS.Application.Service.DS.Core where + +import Control.Monad.Logger +import qualified Data.Text as T +import Control.Monad.Reader +import Control.Lens +import Control.Exception +import System.IO +import Control.Monad.Except + +import qualified PMS.Domain.Model.DM.Type as DM +import qualified PMS.Domain.Model.DM.Constant as DM + +import PMS.Application.Service.DM.Type +import PMS.Application.Service.DS.Utility + +import Control.Concurrent.Async + +-- | +-- +app :: AppContext () +app = flip catchError errHdl $ do + $logDebugS DM._LOGTAG "app called." + + liftIOE $ hSetBuffering stderr LineBuffering + + domCtxs <- view appsAppData <$> ask + domDat <- lift ask + + liftIOE (start domDat domCtxs) >>= \case + (_, Right _) -> $logInfoS DM._LOGTAG "some threads stopped. exit." + (_, Left e) -> $logErrorS DM._LOGTAG $ T.pack $ "some threads stopped. " ++ show e + + where + errHdl :: String -> AppContext () + errHdl msg = do + $logErrorS DM._LOGTAG $ T.pack $ "app: exception occurred. skip. " ++ msg + + start :: DM.DomainData + -> [DM.DomainContext ()] + -> IO (Async (), Either SomeException ()) + start domDat domCtxs = do + as <- mapM (go domDat) domCtxs + waitAnyCatchCancel as + + go :: DM.DomainData -> DM.DomainContext () -> IO (Async ()) + go domDat domCtx = async $ domCtx domDat diff --git a/src/PMS/Application/Service/DS/Utility.hs b/src/PMS/Application/Service/DS/Utility.hs new file mode 100644 --- /dev/null +++ b/src/PMS/Application/Service/DS/Utility.hs @@ -0,0 +1,34 @@ +module PMS.Application.Service.DS.Utility where + + +import System.Log.FastLogger +import qualified Control.Exception.Safe as E +import Control.Monad.IO.Class +import Control.Monad.Except +import Control.Monad.Reader + +import qualified PMS.Domain.Model.DM.Type as DM +import qualified PMS.Domain.Model.DS.Utility as DM + +import PMS.Application.Service.DM.Type + +-- | +-- +runApp :: DM.DomainData -> AppData -> TimedFastLogger -> AppContext a -> IO (Either DM.ErrorData a) +runApp domDat appDat logger ctx = + DM.runFastLoggerT domDat logger + $ runExceptT + $ flip runReaderT domDat + $ runReaderT ctx appDat + + +-- | +-- +liftIOE :: IO a -> AppContext a +liftIOE f = liftIO (go f) >>= liftEither + where + go :: IO b -> IO (Either String b) + go x = E.catchAny (Right <$> x) errHdl + + errHdl :: E.SomeException -> IO (Either String a) + errHdl = return . Left . show diff --git a/test/PMS/Application/Service/App/ControlSpec.hs b/test/PMS/Application/Service/App/ControlSpec.hs new file mode 100644 --- /dev/null +++ b/test/PMS/Application/Service/App/ControlSpec.hs @@ -0,0 +1,88 @@ +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE OverloadedStrings #-} + +module PMS.Application.Service.App.ControlSpec (spec) where + +import Test.Hspec +import Data.Default +import Control.Lens +import qualified Control.Concurrent as C + +import qualified PMS.Domain.Model.DM.Type as DM +import qualified PMS.Application.Service.App.Control as SUT + +-- | +-- +data SpecContext = SpecContext {} + +makeLenses ''SpecContext + +defaultSpecContext :: IO SpecContext +defaultSpecContext = do + return SpecContext {} + +-- | +-- +spec :: Spec +spec = do + runIO $ putStrLn "Start Spec." + beforeAll setUpOnce $ + afterAll tearDownOnce . + beforeWith setUp . + after tearDown $ run + +-- | +-- +setUpOnce :: IO SpecContext +setUpOnce = do + putStrLn "[INFO] EXECUTED ONLY ONCE BEFORE ALL TESTS START." + defaultSpecContext + +-- | +-- +tearDownOnce :: SpecContext -> IO () +tearDownOnce _ = do + putStrLn "[INFO] EXECUTED ONLY ONCE AFTER ALL TESTS FINISH." + +-- | +-- +setUp :: SpecContext -> IO SpecContext +setUp _ = do + putStrLn "[INFO] EXECUTED BEFORE EACH TEST STARTS." + defaultSpecContext + +-- | +-- +tearDown :: SpecContext -> IO () +tearDown _ = do + putStrLn "[INFO] EXECUTED AFTER EACH TEST FINISHES." + +-- | +-- +run :: SpecWith SpecContext +run = do + describe "run" $ do + context "when DomainContext" $ do + it "should be run" $ \_ -> do + putStrLn "[INFO] EXECUTING THE FIRST TEST." + + let args = def + apps = [sample1, sample2] + + SUT.run args apps + +-- | +-- +sample1 :: DM.DomainContext () +sample1 _ = do + putStrLn $ "[INFO] sample1 called." + C.threadDelay (2 * 1000 * 1000) + putStrLn $ "[INFO] sample1 called. end." + +-- | +-- +sample2 :: DM.DomainContext () +sample2 _ = do + putStrLn $ "[INFO] sample2 called." + C.threadDelay (3 * 1000 * 1000) + putStrLn $ "[INFO] sample2 called. end." diff --git a/test/Spec.hs b/test/Spec.hs new file mode 100644 --- /dev/null +++ b/test/Spec.hs @@ -0,0 +1,1 @@ +{-# OPTIONS_GHC -F -pgmF hspec-discover #-}