Detect changes in local files

fsoikin · fsoikin · commit 063fd5f5a30e · 2025-02-17T15:19:37.000-05:00
diff --git a/bootstrap/src/Cache.purs b/bootstrap/src/Cache.purs
@@ -1,5 +1,6 @@
 module Whine.Bootstrap.Cache
   ( cacheDir
+  , dependenciesChanged
   , hashConfig
   , rebuildCache
   , whineCorePackage
@@ -10,12 +11,17 @@ import Whine.Runner.Prelude
 
 import Codec.JSON.DecodeError as DecodeError
 import Control.Monad.Reader (asks)
+import Data.DateTime (DateTime)
+import Data.Formatter.DateTime as Fmt
+import Data.List as List
 import Data.Map as Map
 import Data.Maybe (fromJust)
 import Data.String as String
 import Data.Tuple (uncurry)
+import Data.UUID as UUID
 import JSON as JSON
 import Node.ChildProcess.Types as StdIO
+import Node.Path as NodePath
 import Partial.Unsafe (unsafePartial)
 import Spago.Generated.BuildInfo as BuildInfo
 import Whine.Bootstrap.Execa (execResultSuccessOrDie, execSuccessOrDie_, execa)
@@ -37,7 +43,9 @@ rebuildCache { rulePackages, bundleFile } = do
   logInfo "Please hold on, preparing to whine..."
   logInfo "Applying artificial tears..."
 
-  let mainModule = "Main"
+  unique <- liftEffect $ String.replaceAll (Pattern "-") (Replacement "") <$> UUID.toString <$> UUID.genUUID
+
+  let mainModule = "Main" <> unique
       packageName = "whine-cached-bootstrap"
       dependencies = Map.union rulePackages (uncurry Map.singleton whineCorePackage)
 
@@ -110,7 +118,7 @@ rebuildCache { rulePackages, bundleFile } = do
 
   logSameLine "Revisiting complaints..."
   execSuccessOrDie_ "spago bundle" =<<
-    execa "npx" ["spago", "bundle"] _
+    execa "npx" ["spago", "bundle", "--source-maps"] _
       { cwd = Just cacheDir
       , stdout = Just StdIO.pipe
       , stderr = Just StdIO.pipe
@@ -189,6 +197,44 @@ hashConfig { rulePackages } = hashString $ fold
       PackageVersion v -> formatVersion v
       LocalPackage p -> p.path <> ":" <> fromMaybe "" p.module
 
+dependenciesChanged :: FilePath -> FilePath -> RunnerM Boolean
+dependenciesChanged cwd mapFile = do
+  logDebug $ "Checking dependency timestamps based on " <> mapFile
+  readMapFile >>= case _ of
+    Nothing -> do
+      logDebug $ mapFile <> " doesn't exist. Assuming dependencies have changed."
+      pure true
+    Just { sources } -> do
+      let cleanSources = sources # filter (not ignored)
+      { modifiedTime: mapFileTime } <- FS.stat mapFilePath
+
+      fileStats <- for cleanSources \source -> FS.stat (cwd <> "/" <> source) <#> _.modifiedTime <#> (source /\ _)
+      let mLatestSource = maximumBy (comparing snd) fileStats
+
+      logDebug $ fold
+        [ mapFile, " last modified at", formatTime mapFileTime
+        , ", latest dependency ", maybe "<none>" fst mLatestSource
+        , " time is ", maybe "<none>" (formatTime <<< snd) mLatestSource
+        ]
+      pure $ mLatestSource # maybe true \(_ /\ t) -> mapFileTime < t
+  where
+    mapFilePath = cwd <> "/" <> mapFile
+
+    readMapFile =
+      ifM (FS.exists mapFilePath)
+        (Just <$> (decodeMapFile =<< FS.readFile mapFilePath))
+        (pure Nothing)
+
+    decodeMapFile content = rightOrDie do
+      json <- JSON.parse content
+      J.decode sourceMapCodec json # lmap DecodeError.print
+
+    ignored file =
+      head (String.split (Pattern NodePath.sep) file) # maybe false (_ `elem` ignore)
+
+    ignore =
+      ["node_modules", "<stdin>", ".spago"]
+
 type SpagoYaml =
   { package ::
     { name :: String
@@ -220,3 +266,23 @@ moduleGraphCodec :: J.Codec (Map String { package :: String })
 moduleGraphCodec = J.strMap $ J.object
   { package: J.string
   }
+
+sourceMapCodec :: J.Codec { sources :: Array String }
+sourceMapCodec = J.object { sources: J.array J.string }
+
+formatTime :: DateTime -> String
+formatTime = Fmt.format $ List.fromFoldable
+  [ Fmt.YearFull
+  , Fmt.Placeholder "-"
+  , Fmt.MonthTwoDigits
+  , Fmt.Placeholder "-"
+  , Fmt.DayOfMonthTwoDigits
+  , Fmt.Placeholder "T"
+  , Fmt.Hours24
+  , Fmt.Placeholder ":"
+  , Fmt.MinutesTwoDigits
+  , Fmt.Placeholder ":"
+  , Fmt.SecondsTwoDigits
+  , Fmt.Placeholder "."
+  , Fmt.Milliseconds
+  ]
diff --git a/bootstrap/src/Main.purs b/bootstrap/src/Main.purs
@@ -13,7 +13,7 @@ import Node.ChildProcess.Types as StdIO
 import Node.Process (argv)
 import Node.Process as Node
 import Spago.Generated.BuildInfo as BuildInfo
-import Whine.Bootstrap.Cache (cacheDir, hashConfig, rebuildCache, whineCorePackage)
+import Whine.Bootstrap.Cache (cacheDir, dependenciesChanged, hashConfig, rebuildCache, whineCorePackage)
 import Whine.Bootstrap.Execa (execa)
 import Whine.Bootstrap.JsonCodecs as J
 import Whine.Runner.Cli as Cli
@@ -52,8 +52,17 @@ entryPoint = do
   let configHash = hashConfig { rulePackages }
       bundleFile = "bundle-" <> configHash <> ".mjs"
       bundlePath = cacheDir <> "/" <> bundleFile
+      bundleSourceMapFile = bundleFile <> ".map"
 
-  unlessM (FS.exists bundlePath) $
+  whenM (dependenciesChanged cacheDir bundleSourceMapFile) do
+    logDebug "Some source dependencies of the cached bundle have changed"
+    whenM (FS.exists bundlePath) $
+      FS.unlink bundlePath
+    whenM (FS.exists $ cacheDir <> "/" <> bundleSourceMapFile) $
+      FS.unlink $ cacheDir <> "/" <> bundleSourceMapFile
+
+  unlessM (FS.exists bundlePath) do
+    logDebug "Rebuilding the cached bundle"
     rebuildCache { rulePackages, bundleFile }
 
   unlessM (FS.exists bundlePath) $
diff --git a/dist/npm/package.json b/dist/npm/package.json
@@ -1,6 +1,6 @@
 {
   "name": "whine",
-  "version": "0.0.27",
+  "version": "0.0.28",
   "description": "PureScript linter, extensible, with configurable rules, and one-off escape hatches",
   "keywords": ["purescript", "lint"],
   "author": "Fyodor Soikin <name.fa@gmail.com>",
diff --git a/dist/vscode-extension/package.json b/dist/vscode-extension/package.json
@@ -3,7 +3,7 @@
   "publisher": "collegevine",
   "displayName": "Whine at PureScript",
   "description": "PureScript linter, extensible, with configurable rules, and one-off escape hatches",
-  "version": "0.0.27",
+  "version": "0.0.28",
   "repository": "https://github.com/collegevine/purescript-whine",
   "engines": {
     "vscode": "^1.95.0"
diff --git a/integration-tests/cases/1-local-rules/baseline.txt b/integration-tests/cases/1-local-rules/baseline.txt
@@ -0,0 +1,3 @@
+Local rule configured with 'null' is running on Local.WhineRules
+Local rule configured with 'null' is running on Main
+No violations found.
diff --git a/integration-tests/cases/1-local-rules/spago.yaml b/integration-tests/cases/1-local-rules/spago.yaml
@@ -0,0 +1,12 @@
+package:
+  name: test-package
+  dependencies:
+    - prelude
+    - effect
+    - whine-core
+workspace:
+  packageSet:
+    registry: 62.2.5
+  extraPackages:
+    whine-core:
+      path: PROJECT_PATH
diff --git a/integration-tests/cases/1-local-rules/src/Main.purs b/integration-tests/cases/1-local-rules/src/Main.purs
@@ -0,0 +1,7 @@
+module Main where
+
+import Prelude
+import Effect (Effect)
+
+main :: Effect Unit
+main = pure unit
diff --git a/integration-tests/cases/1-local-rules/src/WhineRules.purs b/integration-tests/cases/1-local-rules/src/WhineRules.purs
@@ -0,0 +1,22 @@
+module Local.WhineRules where
+
+import Prelude
+
+import Data.Codec.JSON as CJ
+import JSON (JSON)
+import JSON as JSON
+import PureScript.CST.Types (Module(..), ModuleHeader(..), ModuleName(..), Name(..))
+import Whine.Log (logInfo)
+import Whine.Types (Handle(..), Rule, RuleFactories, currentModule, emptyRule, ruleFactory)
+
+rules :: RuleFactories
+rules = [ruleFactory "LocalRule" CJ.json localRule]
+
+localRule :: JSON -> Rule
+localRule config = emptyRule { onModule = onModule }
+  where
+    onModule :: Handle Module
+    onModule = Handle \_ ->
+      currentModule \(Module { header: ModuleHeader { name: Name { name: ModuleName n } } }) -> do
+        logInfo $ "Local rule configured with '" <> JSON.print config <> "' is running on " <> n
+        pure unit
diff --git a/integration-tests/cases/1-local-rules/whine-with-local-rule-config.yaml b/integration-tests/cases/1-local-rules/whine-with-local-rule-config.yaml
@@ -0,0 +1,12 @@
+rulePackages:
+  - whine-core:
+      local: PROJECT_PATH
+      module: Whine.Core.WhineRules
+  - local-rules:
+      local: ./
+      module: Local.WhineRules
+
+rules:
+    LocalRule:
+        foo: "bar"
+        baz: 42
diff --git a/integration-tests/cases/1-local-rules/whine.yaml b/integration-tests/cases/1-local-rules/whine.yaml
@@ -0,0 +1,7 @@
+rulePackages:
+  - whine-core:
+      local: PROJECT_PATH
+      module: Whine.Core.WhineRules
+  - local-rules:
+      local: ./
+      module: Local.WhineRules
diff --git a/integration-tests/cases/1-local-rules/with-local-rule-changed.txt b/integration-tests/cases/1-local-rules/with-local-rule-changed.txt
@@ -0,0 +1,18 @@
+[20:06:33.437]: Checking dependency timestamps based on bundle-7c65f400b94f18cc70c53ba2cc3d5d7309f7c7dcfd8f1fff9469eb7884fa5191.mjs.map
+[20:06:33.464]: bundle-7c65f400b94f18cc70c53ba2cc3d5d7309f7c7dcfd8f1fff9469eb7884fa5191.mjs.map last modified at2025-02-17T20:06:31.370, latest dependency ../src/WhineRules.purs time is 2025-02-17T20:06:33.331
+[20:06:33.464]: Some source dependencies of the cached bundle have changed
+[20:06:33.465]: Rebuilding the cached bundle
+Please hold on, preparing to whine...
+Applying artificial tears...
+Coming up with excuses...
+Making a pitiful face...
+Revisiting complaints...
+Done, ready to whine.
+
+[20:06:39.415]: Parsing src/WhineRules.purs
+[20:06:39.430]: Parsed src/WhineRules.purs, running rules
+Local rule changed configured with '{"foo":"bar","baz":42}' is running on Local.WhineRules
+[20:06:39.437]: Parsing src/Main.purs
+[20:06:39.438]: Parsed src/Main.purs, running rules
+Local rule changed configured with '{"foo":"bar","baz":42}' is running on Main
+No violations found.
diff --git a/integration-tests/cases/1-local-rules/with-local-rule-config-debug.txt b/integration-tests/cases/1-local-rules/with-local-rule-config-debug.txt
@@ -0,0 +1,9 @@
+[20:06:33.156]: Checking dependency timestamps based on bundle-7c65f400b94f18cc70c53ba2cc3d5d7309f7c7dcfd8f1fff9469eb7884fa5191.mjs.map
+[20:06:33.180]: bundle-7c65f400b94f18cc70c53ba2cc3d5d7309f7c7dcfd8f1fff9469eb7884fa5191.mjs.map last modified at2025-02-17T20:06:31.370, latest dependency output/Whine.Runner.Yaml/foreign.js time is 2025-02-17T20:06:30.276
+[20:06:33.313]: Parsing src/WhineRules.purs
+[20:06:33.326]: Parsed src/WhineRules.purs, running rules
+Local rule configured with '{"foo":"bar","baz":42}' is running on Local.WhineRules
+[20:06:33.333]: Parsing src/Main.purs
+[20:06:33.334]: Parsed src/Main.purs, running rules
+Local rule configured with '{"foo":"bar","baz":42}' is running on Main
+No violations found.
diff --git a/integration-tests/cases/1-local-rules/with-local-rule-config.txt b/integration-tests/cases/1-local-rules/with-local-rule-config.txt
@@ -0,0 +1,3 @@
+Local rule configured with '{"foo":"bar","baz":42}' is running on Local.WhineRules
+Local rule configured with '{"foo":"bar","baz":42}' is running on Main
+No violations found.
diff --git a/spago.yaml b/spago.yaml
@@ -51,7 +51,7 @@ package:
     dependencies:
       - spec-node
   publish:
-    version: 0.0.27
+    version: 0.0.28
     license: MIT
     location:
       githubOwner: collegevine
diff --git a/src/Whine/Prelude.purs b/src/Whine/Prelude.purs
@@ -11,18 +11,19 @@ import Control.Monad.Error.Class (try) as Reexport
 import Control.Monad.Except (mapExcept, mapExceptT, runExcept, runExceptT) as Reexport
 import Control.Monad.Writer (class MonadWriter, WriterT, execWriterT, mapWriterT, tell) as Reexport
 
-import Data.Array ((!!), (:), (..), (\\), concatMap, find, findMap, foldl, nub, null, cons, drop, dropWhile, elem, filter, length, catMaybes, mapMaybe, last, partition, take, uncons, unsnoc, zip, zipWith) as Reexport
+import Data.Array ((!!), (:), (..), (\\), concatMap, find, findMap, foldl, head, nub, null, cons, drop, dropWhile, elem, filter, length, catMaybes, mapMaybe, last, partition, take, uncons, unsnoc, zip, zipWith) as Reexport
 import Data.Array.NonEmpty (NonEmptyArray) as Reexport
 import Data.Bifunctor (bimap, lmap, rmap) as Reexport
 import Data.Either (Either(..), fromRight, either, hush, note) as Reexport
+import Data.Foldable (maximum, maximumBy) as Reexport
 import Data.FoldableWithIndex (foldlWithIndex, forWithIndex_) as Reexport
 import Data.Identity (Identity(..)) as Reexport
 import Data.Map (Map) as Reexport
 import Data.Maybe (Maybe(..), isNothing, isJust, fromMaybe, maybe) as Reexport
 import Data.Newtype (wrap, unwrap, un) as Reexport
 import Data.Nullable (Nullable) as Reexport
 import Data.Profunctor (dimap) as Reexport
-import Data.String (Pattern(..), joinWith) as Reexport
+import Data.String (Pattern(..), Replacement(..), joinWith) as Reexport
 import Data.String.NonEmpty (NonEmptyString) as Reexport
 import Data.Traversable (any, fold, for, for_, intercalate, traverse, traverse_, sequence, sequence_) as Reexport
 import Data.Tuple (Tuple(..), fst, snd) as Reexport
diff --git a/src/Whine/Runner/FS.purs b/src/Whine/Runner/FS.purs
@@ -5,8 +5,10 @@ module Whine.Runner.FS
 
 import Whine.Runner.Prelude
 
+import Data.DateTime (DateTime)
 import Node.FS.Aff as NodeFS
 import Node.FS.Perms (permsReadWrite)
+import Node.FS.Stats as NodeStats
 import Node.FS.Sync as NodeFSSync
 import Node.Path (relative) as R
 
@@ -29,3 +31,8 @@ exists path = liftEffect $
 unlink :: FilePath -> RunnerM Unit
 unlink path = tryOrDie $ liftAff $
   NodeFS.unlink path
+
+stat :: FilePath -> RunnerM { modifiedTime :: DateTime }
+stat path = do
+  stats <- liftAff $ NodeFS.stat path
+  pure { modifiedTime: NodeStats.modifiedTime stats }
diff --git a/test/FS.purs b/test/FS.purs
@@ -18,6 +18,9 @@ chdir = liftEffect <<< Node.chdir
 exists :: ∀ m. MonadAff m => FilePath -> m Boolean
 exists = liftEffect <<< SyncFS.exists
 
+unlink :: ∀ m. MonadAff m => FilePath -> m Unit
+unlink = liftEffect <<< SyncFS.unlink
+
 newTempDir :: ∀ m. MonadAff m => m String
 newTempDir = do
   tmpdir <- liftEffect $ (\t u -> t <> "/" <> UUID.toString u) <$> NodeOS.tmpdir <*> UUID.genUUID
@@ -40,3 +43,6 @@ copyTree :: ∀ m. MonadAff m => FilePath -> FilePath -> m Unit
 copyTree src dest = liftEffect $ copyTree_ src dest
 
 foreign import copyTree_ :: FilePath -> FilePath -> Effect Unit
+
+copyFile :: ∀ m. MonadAff m => FilePath -> FilePath -> m Unit
+copyFile src dest = liftAff $ FS.copyFile src dest
diff --git a/test/Integration.purs b/test/Integration.purs
diff --git a/whine.yaml b/whine.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "whine",`
`3`		`- "version": "0.0.27",`
	`3`	`+ "version": "0.0.28",`
`4`	`4`	`"description": "PureScript linter, extensible, with configurable rules, and one-off escape hatches",`
`5`	`5`	`"keywords": ["purescript", "lint"],`
`6`	`6`	`"author": "Fyodor Soikin <name.fa@gmail.com>",`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Local rule configured with 'null' is running on Local.WhineRules`
	`2`	`+Local rule configured with 'null' is running on Main`
	`3`	`+No violations found.`