Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Marshal to use strings.Builder #18

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update Marshal to use strings.Builder #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e8eb21
added benchmark to demonstrate performance issue with marshal
Feb 26, 2022
236c69c
updated Marshal to use strings.Builder
Feb 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 23 additions & 21 deletions marshal.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"errors"
"fmt"
"io"
"strings"

"github.com/go-ldap/ldap/v3"
)
Expand All @@ -24,8 +25,9 @@ func Marshal(l *LDIF) (data string, err error) {
hasEntry := false
hasChange := false

var builder strings.Builder
if l.Version > 0 {
data = "version: 1\n"
builder.WriteString("version: 1\n")
}

fw := l.FoldWidth
Expand All @@ -40,8 +42,8 @@ func Marshal(l *LDIF) (data string, err error) {
if hasEntry {
return "", ErrMixed
}
data += foldLine("dn: "+e.Add.DN, fw) + "\n"
data += "changetype: add\n"
builder.WriteString(foldLine("dn: "+e.Add.DN, fw) + "\n")
builder.WriteString("changetype: add\n")
for _, add := range e.Add.Attributes {
if len(add.Vals) == 0 {
return "", errors.New("changetype 'add' requires non empty value list")
Expand All @@ -52,7 +54,7 @@ func Marshal(l *LDIF) (data string, err error) {
if t {
col = ":: "
}
data += foldLine(add.Type+col+ev, fw) + "\n"
builder.WriteString(foldLine(add.Type+col+ev, fw) + "\n")
}
}

Expand All @@ -61,16 +63,16 @@ func Marshal(l *LDIF) (data string, err error) {
if hasEntry {
return "", ErrMixed
}
data += foldLine("dn: "+e.Del.DN, fw) + "\n"
data += "changetype: delete\n"
builder.WriteString(foldLine("dn: "+e.Del.DN, fw) + "\n")
builder.WriteString("changetype: delete\n")

case e.Modify != nil:
hasChange = true
if hasEntry {
return "", ErrMixed
}
data += foldLine("dn: "+e.Modify.DN, fw) + "\n"
data += "changetype: modify\n"
builder.WriteString(foldLine("dn: "+e.Modify.DN, fw) + "\n")
builder.WriteString("changetype: modify\n")
for _, mod := range e.Modify.Changes {
switch mod.Operation {
// add operation - https://tools.ietf.org/html/rfc4511#section-4.6
Expand All @@ -79,43 +81,43 @@ func Marshal(l *LDIF) (data string, err error) {
return "", errors.New("changetype 'modify', op 'add' requires non empty value list")
}

data += "add: " + mod.Modification.Type + "\n"
builder.WriteString("add: " + mod.Modification.Type + "\n")
for _, v := range mod.Modification.Vals {
ev, t := encodeValue(v)
col := ": "
if t {
col = ":: "
}
data += foldLine(mod.Modification.Type+col+ev, fw) + "\n"
builder.WriteString(foldLine(mod.Modification.Type+col+ev, fw) + "\n")
}
data += "-\n"
builder.WriteString("-\n")
// delete operation - https://tools.ietf.org/html/rfc4511#section-4.6
case 1:
data += "delete: " + mod.Modification.Type + "\n"
builder.WriteString("delete: " + mod.Modification.Type + "\n")
for _, v := range mod.Modification.Vals {
ev, t := encodeValue(v)
col := ": "
if t {
col = ":: "
}
data += foldLine(mod.Modification.Type+col+ev, fw) + "\n"
builder.WriteString(foldLine(mod.Modification.Type+col+ev, fw) + "\n")
}
data += "-\n"
builder.WriteString("-\n")
// replace operation - https://tools.ietf.org/html/rfc4511#section-4.6
case 2:
if len(mod.Modification.Vals) == 0 {
return "", errors.New("changetype 'modify', op 'replace' requires non empty value list")
}
data += "replace: " + mod.Modification.Type + "\n"
builder.WriteString("replace: " + mod.Modification.Type + "\n")
for _, v := range mod.Modification.Vals {
ev, t := encodeValue(v)
col := ": "
if t {
col = ":: "
}
data += foldLine(mod.Modification.Type+col+ev, fw) + "\n"
builder.WriteString(foldLine(mod.Modification.Type+col+ev, fw) + "\n")
}
data += "-\n"
builder.WriteString("-\n")
default:
return "", fmt.Errorf("invalid type %s in modify request", mod.Modification.Type)
}
Expand All @@ -125,21 +127,21 @@ func Marshal(l *LDIF) (data string, err error) {
if hasChange {
return "", ErrMixed
}
data += foldLine("dn: "+e.Entry.DN, fw) + "\n"
builder.WriteString(foldLine("dn: "+e.Entry.DN, fw) + "\n")
for _, av := range e.Entry.Attributes {
for _, v := range av.Values {
ev, t := encodeValue(v)
col := ": "
if t {
col = ":: "
}
data += foldLine(av.Name+col+ev, fw) + "\n"
builder.WriteString(foldLine(av.Name+col+ev, fw) + "\n")
}
}
}
data += "\n"
builder.WriteString("\n")
}
return data, nil
return builder.String(), nil
}

func encodeValue(value string) (string, bool) {
Expand Down
78 changes: 78 additions & 0 deletions marshal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ package ldif_test

import (
"bytes"
"fmt"
"strings"
"testing"

"github.com/go-ldap/ldap/v3"
Expand Down Expand Up @@ -71,6 +73,82 @@ var entries = []*ldap.Entry{
},
}

func nPeople(n int) ([]*ldap.Entry, string) {
nEntries := make([]*ldap.Entry, n+1)
var builder strings.Builder

nEntries[0] = entries[0]
builder.WriteString(ouLDIF)

for i := 1; i <= n; i++ {
nEntries[i] = &ldap.Entry{
DN: fmt.Sprintf("uid=someone%d,ou=people,dc=example,dc=org", i),
Attributes: []*ldap.EntryAttribute{
{
Name: "objectClass",
Values: []string{
"top",
"person",
"organizationalPerson",
"inetOrgPerson",
},
},
{
Name: "uid",
Values: []string{fmt.Sprintf("someone%d", i)},
},
{
Name: "cn",
Values: []string{fmt.Sprintf("Someone%d", i)},
},
{
Name: "mail",
Values: []string{fmt.Sprintf("someone%[email protected]", i)},
},
},
}

builder.WriteString(fmt.Sprintf(""+
"dn: uid=someone%d,ou=people,dc=example,dc=org\n"+
"objectClass: top\n"+
"objectClass: person\n"+
"objectClass: organizationalPerson\n"+
"objectClass: inetOrgPerson\n"+
"uid: someone%d\n"+
"cn: Someone%d\n"+
"mail: someone%[email protected]\n"+
"\n",
i, i, i, i))
}

return nEntries, builder.String()
}

func BenchmarkMarshalNEntries(b *testing.B) {
benchmarker := func(n int) {
b.Run(fmt.Sprintf("marshal %d", n), func(b *testing.B) {
entries, expected := nPeople(n)
ldifEntries := make([]*ldif.Entry, len(entries))
for i, entry := range entries {
ldifEntries[i] = &ldif.Entry{Entry: entry}
}
l := &ldif.LDIF{Entries: ldifEntries}
actual, err := ldif.Marshal(l)
if err != nil {
b.Errorf("Failed to marshal entry: %s", err)
}
if actual != expected {
b.Errorf("expected: >>%s<<\nactual: >>%s<<\n", expected, actual)
}
})
}

benchmarker(100)
benchmarker(1000)
benchmarker(10000)
benchmarker(100000)
}

func TestMarshalSingleEntry(t *testing.T) {
l := &ldif.LDIF{
Entries: []*ldif.Entry{
Expand Down