ekuiper-new/internal/io/mqtt/mqtt_sink.go

// Copyright 2021-2023 EMQ Technologies Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://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 mqtt

import (
	"fmt"

	"github.com/lf-edge/ekuiper/internal/compressor"
	"github.com/lf-edge/ekuiper/internal/topo/connection/clients"
	"github.com/lf-edge/ekuiper/pkg/api"
	"github.com/lf-edge/ekuiper/pkg/cast"
	"github.com/lf-edge/ekuiper/pkg/errorx"
	"github.com/lf-edge/ekuiper/pkg/message"
)

// AdConf is the advanced configuration for the mqtt sink
type AdConf struct {
	Tpc         string `json:"topic"`
	Qos         byte   `json:"qos"`
	Retained    bool   `json:"retained"`
	Compression string `json:"compression"`
	ResendTopic string `json:"resendDestination"`
}

type MQTTSink struct {
	adconf     *AdConf
	config     map[string]interface{}
	cli        api.MessageClient
	compressor message.Compressor
}

func (ms *MQTTSink) hasKeys(str []string, ps map[string]interface{}) bool {
	for _, v := range str {
		if _, ok := ps[v]; ok {
			return true
		}
	}
	return false
}

func (ms *MQTTSink) Configure(ps map[string]interface{}) error {
	adconf := &AdConf{}
	err := cast.MapToStruct(ps, adconf)
	if err != nil {
		return err
	}

	if adconf.Tpc == "" {
		return fmt.Errorf("mqtt sink is missing property topic")
	}
	if adconf.Qos != 0 && adconf.Qos != 1 && adconf.Qos != 2 {
		return fmt.Errorf("invalid qos value %v, the value could be only int 0 or 1 or 2", adconf.Qos)
	}
	if adconf.Compression != "" {
		ms.compressor, err = compressor.GetCompressor(adconf.Compression)
		if err != nil {
			return fmt.Errorf("invalid compression method %s", adconf.Compression)
		}
	}
	ms.config = ps
	ms.adconf = adconf
	return nil
}

func (ms *MQTTSink) Open(ctx api.StreamContext) error {
	log := ctx.GetLogger()
	cli, err := clients.GetClient("mqtt", ms.config)
	if err != nil {
		log.Errorf("found error when get mqtt client config %v, error %s", ms.config, err.Error())
		return err
	}
	ms.cli = cli

	return nil
}

func (ms *MQTTSink) Collect(ctx api.StreamContext, item interface{}) error {
	return ms.collectWithTopic(ctx, item, ms.adconf.Tpc)
}

func (ms *MQTTSink) CollectResend(ctx api.StreamContext, item interface{}) error {
	return ms.collectWithTopic(ctx, item, ms.adconf.ResendTopic)
}

func (ms *MQTTSink) collectWithTopic(ctx api.StreamContext, item interface{}, topic string) error {
	logger := ctx.GetLogger()
	jsonBytes, _, err := ctx.TransformOutput(item)
	if err != nil {
		return err
	}
	logger.Debugf("%s publish %s", ctx.GetOpId(), jsonBytes)
	if ms.compressor != nil {
		jsonBytes, err = ms.compressor.Compress(jsonBytes)
		if err != nil {
			return err
		}
	}

	tpc, err := ctx.ParseTemplate(topic, item)
	if err != nil {
		return err
	}

	para := map[string]interface{}{
		"qos":      ms.adconf.Qos,
		"retained": ms.adconf.Retained,
	}

	if err := ms.cli.Publish(ctx, tpc, jsonBytes, para); err != nil {
		return fmt.Errorf("%s: %s", errorx.IOErr, err.Error())
	}
	return nil
}

func (ms *MQTTSink) Close(ctx api.StreamContext) error {
	logger := ctx.GetLogger()
	logger.Infof("Closing mqtt sink")
	if ms.cli != nil {
		clients.ReleaseClient(ctx, ms.cli)
	}
	return nil
}