Package Config/component/LDAP:

- replace mutex by atomic
- fix minor bugs & optimize code

Package Size:
- add function 'mul' allowing do a multiplaction on the size value by a float64 given value (could use another size.float64)
- add function 'div' allowing do a division of the size value by a float64 given value (could use another size.float64)
- add function 'add' allowing do an addtion of the size value with a uint64 given value (could use another size.uint64)
- add function 'sub' allowing do an substraction of the size value with a uint64 given value (could use another size.uint64)

Package Encoding:
- rework completly crypt package to new package encoding
- part aes of old crypt become new subpackage encoding/aes
- part hex of old crypt (associated with aes) become new standalone subpackage encoding/hexa
- adding new subpackage mux to use multiplexer/de-multiplexer of io stream
- mux is different of multireader / multiwriter in way as io send from mux in one channel will be received only in the coresponding channel  of de-mux
- mux is encoding subpackage becauxse based on hex + cbor marshalling / unmarshalling
- all subpackage can be used directly of by io reader / writer

Package Socket/server
- rework server to use as possible direct io to con
- rework server to optimize & fix managment (context / shutdown...)
- rework server to stop connection befor stopping server
- rework server to not load incoming and send it to handler by allowing handler to manager io input/output directly
- server not more used buff internally (less memory consuption)
- adding counter of opened connection
- adding some testing who's checking server & client for each protocol

Package Socket/client
- rework client to allow connect to server before reading/writing on io stream
- rework client to allow consum direct io stream instead of reading locally / call function
- rework client to allow having less memory consumption by removing internal buffer
- rework client allowing to use root io function (bufio, io copy, ...)

Package Socket/multi
- adding new subpackage multi to simplfy using of 1 reader / x writer
- if no writer is define, using an extended io discard
- allowing asynch instancing, populate writer and calling main writer
- allowing calling writer / reader to expose the main io reader / writer

Package Socket/delim:
- adding new subpackage delim to simplify using of bufio reader with delimiter
- using 1 writer / 1 reader
- allowing root io function like readwritecloser, writeto, ...
- use local buffer to prevent race if reader and writer are not is same process

Package PProf:
- fix missing \n in message

Package HttpServer:
- fix bug with init TLS & http2

Other:
- bump dependencies
This commit is contained in:
Nicolas JUHEL
2024-03-17 13:44:38 +01:00
committed by nabbar
parent d84e6a7e9d
commit 9ca3530b1d
87 changed files with 5596 additions and 1033 deletions

118
encoding/mux/demux.go Normal file
View File

@@ -0,0 +1,118 @@
/*
* MIT License
*
* Copyright (c) 2023 Nicolas JUHEL
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*
*/
package mux
import (
"bufio"
"bytes"
"errors"
"io"
libcbr "github.com/fxamacker/cbor/v2"
enchex "github.com/nabbar/golib/encoding/hexa"
)
type dmux struct {
r *bufio.Reader
d byte
m map[rune]io.Writer
}
// Read defines a Read method for the dmux type in Go.
// It reads data from dmux, handles error conditions, and performs data manipulation before writing the data to a specified channel.
func (o *dmux) Read(p []byte) (n int, err error) {
if o == nil {
return 0, ErrInvalidInstance
}
var (
b []byte
d = data{}
h = enchex.New()
)
b, err = o.r.ReadBytes(o.d)
b = bytes.TrimSuffix(b, []byte{o.d})
if err != nil {
return 0, err
}
if len(b) < 1 {
return 0, nil
}
err = libcbr.Unmarshal(b, &d)
if err != nil {
return 0, err
}
if len(d.D) < 1 {
return 0, nil
} else if p, err = h.Decode(d.D); err != nil {
return 0, err
}
if len(o.m) < 1 {
return 0, ErrInvalidChannel
} else if w, k := o.m[d.K]; !k {
return 0, ErrInvalidChannel
} else {
return w.Write(p)
}
}
// Copy defines a method Copy for a type dmux
// that continuously reads data into a buffer p in chunks of 32KB until an error occurs,
// and then returns that error except the error is io.EOF.
func (o *dmux) Copy() error {
var (
e error
p = make([]byte, 32*1024)
)
for e == nil {
clear(p)
_, e = o.Read(p)
}
if errors.Is(e, io.EOF) {
e = nil
}
return e
}
// NewChannel defines a method NewChannel for a type dmux,
// which adds a new channel to the dmux by mapping the given key to the provided writer in the dmux's map.
func (o *dmux) NewChannel(key rune, w io.Writer) {
if o == nil {
return
}
o.m[key] = w
}

101
encoding/mux/interface.go Normal file
View File

@@ -0,0 +1,101 @@
/*
* MIT License
*
* Copyright (c) 2023 Nicolas JUHEL
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*
*/
package mux
import (
"bufio"
"errors"
"io"
)
var (
ErrInvalidInstance = errors.New("invalid de-multiplexer")
ErrInvalidChannel = errors.New("invalid channel key")
)
type Multiplexer interface {
// NewChannel returns an io.Writer that can be used to mux the given byte slice with other channel into the main writer
//
// key is a rune/byte parameter to identify the channel.
// io.Writer is the return type.
NewChannel(key rune) io.Writer
}
// NewMultiplexer creates a new Multiplexer with the given io.Writer and delimiter.
//
// w: io.Writer to write to.
// delim: byte delimiter to use.
// Returns a Multiplexer.
func NewMultiplexer(w io.Writer, delim byte) Multiplexer {
return &mux{
w: w,
d: delim,
}
}
type DeMultiplexer interface {
io.Reader
// Copy launch a continuously reading from the main io.Reader and writing to the correct channel io.Writer
// A good use case is to use it in a goroutine.
//
// returns any error.
Copy() error
// NewChannel registers a new channel to the given io.Writer for the given key as discriminant
//
// Parameters:
// key is a rune/byte parameter to identify the channel.
// w io.Writer the io.writer to write to.
NewChannel(key rune, w io.Writer)
}
// NewDeMultiplexer creates a new DeMultiplexer using the given io.Reader, delimiter byte, and optional buffer size.
// If the buffer size is 0, a default buffer size of 4096 will be used.
//
// Parameters:
//
// r io.Reader - the input reader
// delim byte - the delimiter byte used to identify each block of data
// size int - the buffer size
//
// Return type: DeMultiplexer
func NewDeMultiplexer(r io.Reader, delim byte, size int) DeMultiplexer {
var rb *bufio.Reader
if size > 0 {
rb = bufio.NewReaderSize(r, size)
} else {
rb = bufio.NewReader(r)
}
return &dmux{
r: rb,
d: delim,
m: make(map[rune]io.Writer),
}
}

44
encoding/mux/model.go Normal file
View File

@@ -0,0 +1,44 @@
/*
* MIT License
*
* Copyright (c) 2023 Nicolas JUHEL
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*
*/
package mux
type data struct {
K rune
D []byte
}
type wrt struct {
f func(p []byte) (n int, e error)
}
func (w *wrt) Write(p []byte) (n int, err error) {
if w.f == nil {
return 0, ErrInvalidInstance
} else {
return w.f(p)
}
}

78
encoding/mux/mux.go Normal file
View File

@@ -0,0 +1,78 @@
/*
* MIT License
*
* Copyright (c) 2023 Nicolas JUHEL
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*
*/
package mux
import (
"io"
libcbr "github.com/fxamacker/cbor/v2"
enchex "github.com/nabbar/golib/encoding/hexa"
)
type mux struct {
w io.Writer
d byte
}
// NewChannel This Function defines a method NewChannel for a type mux in Go. It returns an io.Writer interface.
// The method creates a function that takes a byte slice, marshals it into a data struct, appends a field o.d to the byte slice, then writes the resulting byte slice to an io.Writer o.w.
// If successful, it returns the number of bytes written.
func (o *mux) NewChannel(key rune) io.Writer {
if o == nil {
return &wrt{
f: func(p []byte) (n int, e error) {
return 0, ErrInvalidInstance
},
}
}
var crp = enchex.New()
return &wrt{
f: func(p []byte) (n int, e error) {
n = len(p)
var d = data{
K: key,
D: crp.Encode(p),
}
clear(p)
p, e = libcbr.Marshal(&d)
p = append(p, o.d)
if e != nil {
return 0, e
} else if _, e = o.w.Write(p); e != nil {
return 0, e
} else {
return n, nil
}
},
}
}

View File

@@ -0,0 +1,53 @@
/*
* MIT License
*
* Copyright (c) 2023 Nicolas JUHEL
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*
*/
package mux_test
import (
"testing"
"time"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
)
/*
Using https://onsi.github.io/ginkgo/
Running with $> ginkgo -cover .
*/
// TestGolibEncodingMuxHelper tests the Golib Mux Encoding Helper function.
func TestGolibEncodingMuxHelper(t *testing.T) {
time.Sleep(500 * time.Millisecond) // Adding delay for better testing synchronization
RegisterFailHandler(Fail) // Registering fail handler for better test failure reporting
RunSpecs(t, "Encoding Mux Helper Suite") // Running the test suite for Encoding Mux Helper
}
var _ = BeforeSuite(func() {
})
var _ = AfterSuite(func() {
})

108
encoding/mux/mux_test.go Normal file
View File

@@ -0,0 +1,108 @@
/*
* MIT License
*
* Copyright (c) 2023 Nicolas JUHEL
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*
*/
package mux_test
import (
"bytes"
"fmt"
"io"
encmux "github.com/nabbar/golib/encoding/mux"
libsck "github.com/nabbar/golib/socket"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
)
var _ = Describe("encoding/mux", func() {
Context("complete mux/demux", func() {
var (
err error
nbr int
mux encmux.Multiplexer
dmx encmux.DeMultiplexer
buf = bytes.NewBuffer(make([]byte, 0, 32*1024)) // multiplexed buffer
bsa io.Writer // stream for 'a' source
bra = bytes.NewBuffer(make([]byte, 0, 32*1024)) // buffer for 'a' result
bsb io.Writer // stream for 'b' source
brb = bytes.NewBuffer(make([]byte, 0, 32*1024)) // buffer for 'b' result
)
It("Create new multiplexer must succeed", func() {
mux = encmux.NewMultiplexer(buf, libsck.EOL)
Expect(mux).ToNot(BeNil())
})
It("Create new de-multiplexer must succeed", func() {
dmx = encmux.NewDeMultiplexer(buf, libsck.EOL, 0)
Expect(dmx).ToNot(BeNil())
})
It("Create new channel must succeed", func() {
dmx.NewChannel('a', bra)
bsa = mux.NewChannel('a')
Expect(bsa).NotTo(BeNil())
dmx.NewChannel('b', brb)
bsb = mux.NewChannel('b')
Expect(bsb).NotTo(BeNil())
})
It("sending on an io.writer must succeed", func() {
nbr, err = fmt.Fprintln(bsa, "Hello World")
Expect(err).ToNot(HaveOccurred())
Expect(nbr).To(BeEquivalentTo(12))
})
It("sending on an io.writer must succeed", func() {
nbr, err = fmt.Fprintln(bsb, "Hello World")
Expect(err).ToNot(HaveOccurred())
Expect(nbr).To(BeEquivalentTo(12))
})
It("sending on an io.writer must succeed", func() {
nbr, err = fmt.Fprintln(bsa, "Hello World #2\nHello World #3"+string(libsck.EOL)+"!!")
Expect(err).ToNot(HaveOccurred())
Expect(nbr).To(BeEquivalentTo(33))
})
It("sending on an io.writer must succeed", func() {
nbr, err = fmt.Fprintln(bsa, "Hello World #3")
Expect(err).ToNot(HaveOccurred())
Expect(nbr).To(BeEquivalentTo(15))
})
It("Reading on an io.reader must succeed", func() {
err = dmx.Copy()
Expect(err).ToNot(HaveOccurred())
Expect(bra.Len()).To(BeEquivalentTo(60))
Expect(brb.Len()).To(BeEquivalentTo(12))
})
})
})