feat: add APIs for local time and time zones

.vscode/launch.json

@@ -187,6 +187,10 @@
           "label": "Text Generation Model Example",
           "value": "textgeneration"
         },
+        {
+          "label": "Time Example",
+          "value": "time"
+        },
         {
           "label": "Vectors API Example",
           "value": "vectors"

CHANGELOG.md

@@ -7,7 +7,8 @@
 - test: add tests for AssemblyScript SDK Transform [#659](https://github.com/hypermodeinc/modus/pull/659)
 - fix: improve Go version handling [#660](https://github.com/hypermodeinc/modus/pull/660)
 - fix: update runtime wasm tests [#661](https://github.com/hypermodeinc/modus/pull/661)
-- fix: support TinyGo 0.35.0 [#661](https://github.com/hypermodeinc/modus/pull/662)
+- fix: support TinyGo 0.35.0 [#662](https://github.com/hypermodeinc/modus/pull/662)
+- feat: add APIs for local time and time zones [#663](https://github.com/hypermodeinc/modus/pull/663)
 
 ## 2024-12-13 - Runtime 0.15.0
 

cspell.json

@@ -24,6 +24,7 @@
     "buger",
     "buildmode",
     "cconf",
+    "checklinkname",
     "chewxy",
     "classid",
     "codegen",
@@ -97,6 +98,7 @@
     "Lessable",
     "lestrrat",
     "linkname",
+    "localtime",
     "logit",
     "logits",
     "logprob",
@@ -176,6 +178,7 @@
     "tseslint",
     "tsrv",
     "typedarray",
+    "tzif",
     "uids",
     "uncategorized",
     "Unmarshalled",
@@ -209,6 +212,7 @@
     "xsync",
     "xxhash",
     "zenquotes",
-    "zerolog"
+    "zerolog",
+    "zoneinfo"
   ]
 }

go.work

@@ -19,6 +19,7 @@ use (
 	./sdk/go/examples/postgresql
 	./sdk/go/examples/simple
 	./sdk/go/examples/textgeneration
+	./sdk/go/examples/time
 	./sdk/go/examples/vectors
 	./sdk/go/templates/default
 )

runtime/.goreleaser.yaml

@@ -23,7 +23,14 @@ builds:
       - amd64
       - arm64
     mod_timestamp: "{{ .CommitTimestamp }}"
-    ldflags: -s -w -X github.com/hypermodeinc/modus/runtime/config.version={{.Version}}
+    ldflags:
+      - -s
+      - -w
+      - -X github.com/hypermodeinc/modus/runtime/config.version={{.Version}}
+      - >-
+        {{- if eq .Os "windows"}}
+          -checklinkname=0
+        {{- end }}
 
 # temporarily disabled
 # notarize:

runtime/Makefile

@@ -1,12 +1,14 @@
 EXECUTABLE := modus_runtime
 VERSION := $(shell git describe --tags --always --match 'runtime/*' | sed 's/^runtime\///')
+LDFLAGS := -s -w -X github.com/hypermodeinc/modus/runtime/config.version=$(VERSION)
 
 ifneq ($(OS), Windows_NT)
 	OS := $(shell uname -s)
 endif
 
 ifeq ($(OS), Windows_NT)
 	EXECUTABLE := $(EXECUTABLE).exe
+	LDFLAGS := $(LDFLAGS) -checklinkname=0
 endif
 
 .PHONY: all
@@ -23,7 +25,7 @@ build-explorer:
 
 .PHONY: build
 build: build-explorer
-	go build -o $(EXECUTABLE) -ldflags "-s -w -X github.com/hypermodeinc/modus/runtime/config.version=$(VERSION)" .
+	go build -o $(EXECUTABLE) -ldflags "$(LDFLAGS)" .
 
 .PHONY: run
 run: build-explorer

runtime/go.mod

@@ -48,6 +48,7 @@ require (
 	github.com/wundergraph/graphql-go-tools/execution v1.1.0
 	github.com/wundergraph/graphql-go-tools/v2 v2.0.0-rc.136
 	golang.org/x/exp v0.0.0-20241217172543-b2144cdd0a67
+	golang.org/x/sys v0.28.0
 	google.golang.org/grpc v1.69.2
 )
 
@@ -131,7 +132,6 @@ require (
 	golang.org/x/crypto v0.31.0 // indirect
 	golang.org/x/net v0.33.0 // indirect
 	golang.org/x/sync v0.10.0 // indirect
-	golang.org/x/sys v0.28.0 // indirect
 	golang.org/x/text v0.21.0 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20241216192217-9240e9c98484 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20241216192217-9240e9c98484 // indirect

runtime/graphql/graphql.go

@@ -21,6 +21,7 @@ import (
 	"github.com/hypermodeinc/modus/runtime/logger"
 	"github.com/hypermodeinc/modus/runtime/manifestdata"
 	"github.com/hypermodeinc/modus/runtime/pluginmanager"
+	"github.com/hypermodeinc/modus/runtime/timezones"
 	"github.com/hypermodeinc/modus/runtime/utils"
 	"github.com/hypermodeinc/modus/runtime/wasmhost"
 
@@ -101,6 +102,18 @@ func handleGraphQLRequest(w http.ResponseWriter, r *http.Request) {
 	output := make(map[string]wasmhost.ExecutionInfo)
 	ctx = context.WithValue(ctx, utils.FunctionOutputContextKey, output)
 
+	// Set time zone in the context
+	var timeZone string
+	if tz := r.Header.Get("X-Time-Zone"); tz != "" {
+		// If the X-Time-Zone header is set in the request, use that time zone.
+		timeZone = tz
+	} else {
+		// Otherwise, use the host's local time zone.
+		// Note, the TZ environment variable can be set to override the actual local time zone.
+		timeZone = timezones.GetLocalTimeZone()
+	}
+	ctx = context.WithValue(ctx, utils.TimeZoneContextKey, timeZone)
+
 	// Set tracing options
 	var options = []eng.ExecutionOptions{}
 	if utils.TraceModeEnabled() {

runtime/hostfunctions/system.go

@@ -13,15 +13,19 @@ import (
 	"context"
 	"fmt"
 	"os"
+	"time"
 
 	"github.com/hypermodeinc/modus/runtime/logger"
+	"github.com/hypermodeinc/modus/runtime/timezones"
 	"github.com/hypermodeinc/modus/runtime/utils"
 )
 
 func init() {
 	const module_name = "modus_system"
 
 	registerHostFunction(module_name, "logMessage", LogMessage)
+	registerHostFunction(module_name, "getTimeInZone", GetTimeInZone)
+	registerHostFunction(module_name, "getTimeZoneData", GetTimeZoneData)
 }
 
 func LogMessage(ctx context.Context, level, message string) {
@@ -46,3 +50,29 @@ func LogMessage(ctx context.Context, level, message string) {
 		Bool("user_visible", true).
 		Msg("Message logged from function.")
 }
+
+func GetTimeInZone(ctx context.Context, tz *string) *string {
+	now := time.Now()
+
+	var loc *time.Location
+	if tz != nil && *tz != "" {
+		loc = timezones.GetLocation(*tz)
+	} else if tz, ok := ctx.Value(utils.TimeZoneContextKey).(string); ok {
+		loc = timezones.GetLocation(tz)
+	}
+
+	if loc != nil {
+		now = now.In(loc)
+	}
+
+	s := now.Format(time.RFC3339Nano)
+	return &s
+}
+
+func GetTimeZoneData(tz, format *string) []byte {
+	if tz == nil {
+		return nil
+	}
+
+	return timezones.GetTimeZoneData(*tz, *format)
+}

runtime/timezones/timezones.go

@@ -0,0 +1,90 @@
+/*
+ * Copyright 2024 Hypermode Inc.
+ * Licensed under the terms of the Apache License, Version 2.0
+ * See the LICENSE file that accompanied this code for further details.
+ *
+ * SPDX-FileCopyrightText: 2024 Hypermode Inc. <[email protected]>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package timezones
+
+import (
+	"fmt"
+	"os"
+	"time"
+
+	"github.com/puzpuzpuz/xsync/v3"
+)
+
+type tzInfo struct {
+	location *time.Location
+	data     []byte
+}
+
+var systemTimeZone string
+var tzCache = *xsync.NewMapOf[string, *tzInfo]()
+
+func init() {
+	if tz, err := getSystemLocalTimeZone(); err == nil {
+		systemTimeZone = tz
+	} else {
+		fmt.Fprintf(os.Stderr, "failed to determine system local time zone (using UTC): %v\n", err)
+		systemTimeZone = "UTC"
+	}
+}
+
+func GetLocalTimeZone() string {
+	// check every time, in case the env var has changed via .env file reload
+	if tz := os.Getenv("TZ"); tz != "" {
+		return tz
+	}
+
+	return systemTimeZone
+}
+
+func GetLocation(tz string) *time.Location {
+	if tz == "" {
+		return nil
+	}
+
+	info, err := getTimeZoneInfo(tz)
+	if err != nil {
+		return nil
+	}
+
+	return info.location
+}
+
+func GetTimeZoneData(tz, format string) []byte {
+	if tz == "" {
+		return nil
+	}
+
+	// only support tzif format for now
+	// we can expand this to support other formats as needed
+	if format != "tzif" {
+		return nil
+	}
+
+	info, err := getTimeZoneInfo(tz)
+	if err != nil {
+		return nil
+	}
+
+	return info.data
+}
+
+func getTimeZoneInfo(tz string) (*tzInfo, error) {
+	if info, ok := tzCache.Load(tz); ok {
+		return info, nil
+	}
+
+	info, err := loadTimeZoneInfo(tz)
+	if err != nil {
+		return nil, err
+	}
+
+	tzCache.Store(tz, info)
+	return info, nil
+}

runtime/timezones/tzdata_other.go

@@ -0,0 +1,59 @@
+//go:build !windows
+
+/*
+ * Copyright 2024 Hypermode Inc.
+ * Licensed under the terms of the Apache License, Version 2.0
+ * See the LICENSE file that accompanied this code for further details.
+ *
+ * SPDX-FileCopyrightText: 2024 Hypermode Inc. <[email protected]>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package timezones
+
+import (
+	"errors"
+	"fmt"
+	"os"
+	"path"
+	"strings"
+	"time"
+)
+
+func loadTimeZoneInfo(tz string) (*tzInfo, error) {
+	tzFile := "/usr/share/zoneinfo/" + tz
+	if _, err := os.Stat(tzFile); err != nil {
+		return nil, fmt.Errorf("could not find timezone file: %v", err)
+	}
+
+	bytes, err := os.ReadFile(tzFile)
+	if err != nil {
+		return nil, fmt.Errorf("could not read timezone file: %v", err)
+	}
+
+	loc, err := time.LoadLocationFromTZData(tz, bytes)
+	if err != nil {
+		return nil, fmt.Errorf("could not load timezone data: %v", err)
+	}
+
+	info := &tzInfo{loc, bytes}
+	return info, nil
+}
+
+func getSystemLocalTimeZone() (string, error) {
+	// On Linux and macOS, we use the system default /etc/localtime file to get the time zone.
+	// It is a symlink to the time zone file within the OS's copy of the IANA time zone database.
+	// The time zone identifier is the path to the file relative to the zoneinfo folder.
+
+	p, err := os.Readlink("/etc/localtime")
+	if err == nil {
+		segments := strings.Split(p, string(os.PathSeparator))
+		for i := len(segments) - 1; i >= 0; i-- {
+			if segments[i] == "zoneinfo" {
+				return path.Join(segments[i+1:]...), nil
+			}
+		}
+	}
+
+	return "", errors.New("failed to determine system local time zone")
+}