rsc: Create configurable no-op rsc runner (#1523)

* rsc: Create configurable no-op rsc runner

* cleanup

* address comments

* add doc comment

* more doc functions

* fix alpine build

* Revert "fix alpine build"

This reverts commit e704d01.

Author: V-FEXrt

.wakemanifest

@@ -34,6 +34,8 @@ share/wake/lib/system/path.wake
 share/wake/lib/system/plan_scorer.wake
 share/wake/lib/system/plan.wake
 share/wake/lib/system/runner.wake
+share/wake/lib/system/remote_cache_api.wake
+share/wake/lib/system/remote_cache.wake
 share/wake/lib/system/sources.wake
 src/compat/compat.wake
 src/dst/dst.wake

share/wake/lib/system/remote_cache.wake

@@ -0,0 +1,55 @@
+# Copyright 2024 SiFive, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You should have received a copy of LICENSE.Apache2 along with
+# this software. If not, you may obtain a copy at
+#
+#    https://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.
+
+package wake
+
+# rscRunner: Creates a remote cache runner for a given api config
+#
+# ```
+# rscRunner (RemoteCacheApi "local" 1234 "auth") = (Runner ...)
+# ```
+export target rscRunner (rscApi: RemoteCacheApi): Runner =
+    mkRemoteCacheRunner rscApi (\_ Pass "") "/workspace" fuseRunner
+
+# mkRemoteCacheRunner: Creates a remote cache runner from an underlying runner
+#
+# - `rscApi`: the remote cache to connect to
+# - `hashFn`: a runner provided hash, used to invalate jobs that match by key but not by something
+#   known only to the runner
+# - `wakeroot`: Absolute path to the root of the wake project
+# - `baseRunner`: The runner that should be used for a cache miss
+# ```
+# mkRemoteCacheRunner (RemoteCacheApi ...) (\_ Pass "") "" baseRunner = (Runner ...)
+# ```
+export def mkRemoteCacheRunner (_rscApi: RemoteCacheApi) (_hashFn: Result RunnerInput Error => Result String Error) (_wakeroot: String) ((Runner name score baseDoIt): Runner): Runner =
+    def badlaunch job error = prim "job_fail_launch"
+
+    def doit job runnerInput = match runnerInput
+        Fail e ->
+            def _ = badlaunch job e
+
+            Fail e
+        Pass input ->
+            # TODO: Search the cache for the job
+
+            # Run the job to get the results
+            require Pass output = baseDoIt job (Pass input)
+
+            # TODO: Insert the job into the cache
+
+            Pass output
+
+    Runner "remote-cache: {name}" score doit
+

share/wake/lib/system/remote_cache_api.wake

@@ -0,0 +1,55 @@
+# Copyright 2024 SiFive, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You should have received a copy of LICENSE.Apache2 along with
+# this software. If not, you may obtain a copy at
+#
+#    https://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.
+
+package wake
+
+# Configuration details required to connect to the remote shared cache.
+export tuple RemoteCacheApi =
+    # The domain or ip address of the cache
+    export Domain: String
+    # The port serving the cache
+    export Port: Integer
+    # The api key required for authenicated routes. Not required for all requests
+    export Authorization: Option String
+
+# makeRemoteCacheApi: Parses config string into RemoteCacheApi
+#
+# ```
+#  makeRemoteCacheApi "local:1234:myauth" = Pass (RemoteCacheApi "local" 1234 (Some "myauth"))
+#  makeRemoteCacheApi "local:1234:" = Pass (RemoteCacheApi "local" 1234 None)
+#  makeRemoteCacheApi "local:1234" = Fail (...)
+#  makeRemoteCacheApi "local" = Fail (...)
+#  makeRemoteCacheApi "local:asdf:myauth" = Fail (...)
+# ```
+export def makeRemoteCacheApi (config: String): Result RemoteCacheApi Error =
+    require (domain, portStr, authStr, Nil) =
+        config
+        | tokenize `:`
+    else
+        failWithError
+        "Remote cache config was set with incorrect format. Saw: '{config}'. Expected 'domain:port:auth' (auth may be omitted)"
+
+    require Some (port) =
+        portStr
+        | int
+    else failWithError "Remote cache config was set with non-integer port. Saw: {portStr}"
+
+    def auth = if authStr ==* "" then None else Some authStr
+
+    RemoteCacheApi domain port auth
+    | Pass
+
+# TODO: methods such as "downloadFile" and "postJob" should be implemented here.
+

share/wake/lib/system/runner.wake

@@ -148,17 +148,25 @@ export def fuseRunner: Runner =
     | makeJSONRunner
 
 export def defaultRunner: Runner =
-    require Some _ = getenv "WAKE_LOCAL_JOB_CACHE"
-    else fuseRunner
-
-    # The fuseRunner does not actully mount over / and instead uses the
-    # the host root as the sandbox root. This means that wakeroot will
-    # change from depending on where wake is being run from. As a hack
-    # to work around this we abuse the fact that the fuseRunner only
-    # works in relative paths to make different runs consistent. Ideally
-    # you'd have a more complex sandbox that kept the wakeroot at a
-    # consistent place across runs.
-    mkJobCacheRunner (\_ Pass "") "/workspace" fuseRunner
+    require Some config = getenv "WAKE_REMOTE_CACHE"
+    else
+        require Some _ = getenv "WAKE_LOCAL_JOB_CACHE"
+        else fuseRunner
+
+        # The fuseRunner does not actully mount over / and instead uses the
+        # the host root as the sandbox root. This means that wakeroot will
+        # change from depending on where wake is being run from. As a hack
+        # to work around this we abuse the fact that the fuseRunner only
+        # works in relative paths to make different runs consistent. Ideally
+        # you'd have a more complex sandbox that kept the wakeroot at a
+        # consistent place across runs.
+        mkJobCacheRunner (\_ Pass "") "/workspace" fuseRunner
+
+    def remoteCacheApi = match (makeRemoteCacheApi config)
+        Pass x -> x
+        Fail (Error why _) -> panic why
+
+    rscRunner remoteCacheApi
 
 # A plan describing how to construct a JSONRunner
 # RawScript: the path to the script to run jobs with