Merge pull request #80 from nextmv-io/develop

Release v0.19.1

Author: sebastian-quintero

.github/workflows/go-build-test.yml

@@ -1,7 +1,7 @@
 name: go build & test
 on: [push]
 jobs:
-  sdk:
+  sdk-go-build-test:
     runs-on: ubuntu-latest
     env:
       GOPRIVATE: github.com/nextmv-io/*
@@ -59,22 +59,12 @@ jobs:
           # replaced for the local sdk repo checked out in this action.
           go mod edit -replace=github.com/nextmv-io/sdk=${{env.SDK_PATH}}
 
-          # Create the path where the shared object binaries are going to be
-          # saved.
-          VERSION=$(go run cmd/version/main.go)
-          GOVERSION=$(go env GOVERSION)
-          GOOS=$(go env GOOS)
-          GOARCH=$(go env GOARCH)
-          OUT_PATH=${{env.NEXTMV_LIBRARY_PATH}}/nextmv-sdk-$VERSION-$GOVERSION-$GOOS-$GOARCH.so
-
-          # Build without -trimpath because the sdk dependency is being
-          # replaced for the local sdk repo used in the action.
-          cd plugins/sdk
-          go build -buildmode plugin -o $OUT_PATH
+          # Build the plugins.
+          REMOVE_TRIMPATH=1 NEXTMV_LIBRARY_PATH=${{ env.NEXTMV_LIBRARY_PATH }} bash scripts/build.sh
         working-directory: ${{env.RESOURCES}}
 
       - name: go build
         run: go build -v ./...
 
       - name: go test
-        run: NEXTMV_LIBRARY_PATH=${{ env.NEXTMV_LIBRARY_PATH }} NEXTMV_TOKEN=$(nextmv token) go test -v ./...
+        run: NEXTMV_LIBRARY_PATH=${{ env.NEXTMV_LIBRARY_PATH }} NEXTMV_TOKEN=$(nextmv token) go test ./...

.github/workflows/go-lint.yml

@@ -1,7 +1,7 @@
 name: go lint
 on: [push]
 jobs:
-  sdk:
+  sdk-go-lint:
     runs-on: ubuntu-latest
     steps:
       - name: set up go

.github/workflows/markdown-lint.yml

@@ -1,21 +1,14 @@
 name: markdown lint
 on: [push]
 jobs:
-  sdk:
+  sdk-markdown-lint:
     runs-on: ubuntu-latest
     steps:
+      # Checkout the changes
       - name: git clone
         uses: actions/checkout@v3
 
-      - name: set up Node.js
-        uses: actions/setup-node@v3
+      # Use markdownlint-cli2
+      - uses: DavidAnson/markdownlint-cli2-action@v7
         with:
-          node-version: "14"
-
-      - name: install markdownlint-cli2
-        run: |
-          npm install markdownlint-cli2 --global
-
-      - name: run markdownlint-cli2
-        run: |
-          markdownlint-cli2 "**/*.md"
+          globs: "**/*.md"

README.md

@@ -10,16 +10,7 @@ problems. Please find the following packages:
       output.
 - [model][model]: modeling components such as integer domains and ranges.
 
-Please visit the official [Go Package Docs][pkgsite] for documentation and
-testable examples.
-
-## Usage
-
-To run a decision automation problem with SDK you need the [Nextmv CLI][cli].
-
-## Get started
-
-Please visit the [tour of SDK][tour] to get started with data store modeling.
+Please visit the official [Nextmv docs][docs] for comprehensive information.
 
 ## Installation
 
@@ -29,10 +20,8 @@ Nextmv's SDK is meant to be used in Go projects. To download please run:
 go get github.com/nextmv-io/sdk
 ```
 
-[pkgsite]: https://pkg.go.dev/github.com/nextmv-io/sdk
 [store]: ./store
 [route]: ./route
 [run]: ./run
 [model]: ./model
-[tour]: https://github.com/nextmv-io/tour
-[cli]: https://docs.nextmv.io/development/cli
+[docs]: https://docs.nextmv.io

VERSION

@@ -1 +1 @@
-v0.19.0
+v0.19.1

connect/connect.go

@@ -0,0 +1,61 @@
+// Package connect provides a Connector which allows to connect method
+// definition with their implementations in plugins
+package connect
+
+import (
+	"fmt"
+	"runtime"
+	"strings"
+	"sync"
+
+	"github.com/nextmv-io/sdk/plugin"
+)
+
+// Connector connects methods with their implementations in plugins.
+type Connector struct {
+	connected    map[any]struct{}
+	mtx          sync.Mutex
+	slug, prefix string
+}
+
+// NewConnector creates a new Connector.
+func NewConnector(slug, prefix string) *Connector {
+	return &Connector{
+		connected: make(map[any]struct{}),
+		slug:      slug,
+		prefix:    prefix,
+	}
+}
+
+// Connect connects a method with its implementation.
+func Connect[T any](c *Connector, target *T, suffix ...string) {
+	if _, ok := c.connected[target]; ok {
+		return
+	}
+
+	c.mtx.Lock()
+	defer c.mtx.Unlock()
+
+	if _, ok := c.connected[target]; ok {
+		return
+	}
+
+	// get the calling function, get ok to make linter happy
+	pc, _, _, ok := runtime.Caller(1)
+	// we don't actually need ok, so noop
+	_ = ok
+	// get name of the calling function
+	fullName := runtime.FuncForPC(pc).Name()
+	trimmed := strings.TrimSuffix(fullName, "[...]")
+	split := strings.Split(trimmed, ".")
+	name := split[len(split)-1]
+
+	// for methods that share more mapped names, such as NewMap, we use a suffix
+	if len(suffix) == 1 {
+		name += suffix[0]
+	}
+
+	// connect by convention
+	plugin.Connect(c.slug, fmt.Sprintf("%s%s", c.prefix, name), target)
+	c.connected[target] = struct{}{}
+}

mip/connect.go

@@ -50,12 +50,13 @@ func ExampleObjective_terms() {
 	fmt.Println(t3.Var().Index())
 	fmt.Println(t3.Coefficient())
 
-	fmt.Println(len(model.Objective().Terms()))
-	fmt.Println(model.Objective().Terms()[0].Coefficient())
-	fmt.Println(model.Objective().IsMaximize())
-	fmt.Println(model.Objective().Terms()[0])
-	fmt.Println(model.Objective().Terms()[1])
-	// Output:
+	terms := model.Objective().Terms()
+	fmt.Println(len(terms))
+	for _, term := range terms {
+		fmt.Println(term.Var(), term.Coefficient())
+	}
+	fmt.Println("isMaximize: ", model.Objective().IsMaximize())
+	// Unordered output:
 	// 0
 	// 2 B0
 	// 1 B0
@@ -67,10 +68,9 @@ func ExampleObjective_terms() {
 	// 1
 	// 3
 	// 2
-	// 3
-	// false
-	// 3 B0
-	// 3 B1
+	// B0 3
+	// B1 3
+	// isMaximize:  false
 }
 
 func benchmarkObjectiveNewTerms(nrTerms int, b *testing.B) {

mip/example_objective_test.go

@@ -1,24 +1,27 @@
 package mip
 
+import "github.com/nextmv-io/sdk/connect"
+
 // NewSolveOptions returns default solver options.
 func NewSolveOptions() SolveOptions {
-	connect()
+	connect.Connect(con, &newSolveOptions)
 	return newSolveOptions()
 }
 
 // NewModel creates an empty MIP model.
 func NewModel() Model {
-	connect()
+	connect.Connect(con, &newModel)
 	return newModel()
 }
 
 // NewSolver returns a new Solver implemented by the given provider.
 func NewSolver(provider SolverProvider, model Model) (Solver, error) {
-	connect()
+	connect.Connect(con, &model)
 	return newSolver(provider, model)
 }
 
 var (
+	con             = connect.NewConnector("sdk", "MIP")
 	newSolveOptions func() SolveOptions
 	newSolver       func(SolverProvider, Model) (Solver, error)
 	newModel        func() Model

mip/mip.go

@@ -1,6 +1,10 @@
 package model
 
-import "math/bits"
+import (
+	"math/bits"
+
+	"github.com/nextmv-io/sdk/connect"
+)
 
 // Constants for integer bounds.
 const (
@@ -108,41 +112,42 @@ type Iterator interface {
 
 // NewDomain creates a domain of integers.
 func NewDomain(ranges ...Range) Domain {
-	connect()
+	connect.Connect(con, &newDomainFunc)
 	return newDomainFunc(ranges...)
 }
 
 // Singleton creates a domain containing one integer value.
 func Singleton(value int) Domain {
-	connect()
+	connect.Connect(con, &singletonFunc)
 	return singletonFunc(value)
 }
 
 // Multiple creates a domain containing multiple integer values.
 func Multiple(values ...int) Domain {
-	connect()
+	connect.Connect(con, &multipleFunc)
 	return multipleFunc(values...)
 }
 
 // NewDomains creates a sequence of domains.
 func NewDomains(domains ...Domain) Domains {
-	connect()
+	connect.Connect(con, &newDomainsFunc)
 	return newDomainsFunc(domains...)
 }
 
 // Repeat a domain n times.
 func Repeat(n int, d Domain) Domains {
-	connect()
+	connect.Connect(con, &repeatFunc)
 	return repeatFunc(n, d)
 }
 
 // NewRange create a new integer range.
 func NewRange(min, max int) Range {
-	connect()
+	connect.Connect(con, &newRangeFunc)
 	return newRangeFunc(min, max)
 }
 
 var (
+	con            = connect.NewConnector("sdk", "Model")
 	newDomainFunc  func(...Range) Domain
 	singletonFunc  func(int) Domain
 	multipleFunc   func(...int) Domain