feat: remove deprecated stuff (#726)

pkg/modules/libreoffice/api/api.go

@@ -47,7 +47,6 @@ type Options struct {
 	Landscape bool
 
 	// PageRanges allows to select the pages to convert.
-	// TODO: should prefer a method form PdfEngine.
 	// Optional.
 	PageRanges string
 
@@ -80,21 +79,6 @@ func (a *Api) Descriptor() gotenberg.ModuleDescriptor {
 		ID: "libreoffice-api",
 		FlagSet: func() *flag.FlagSet {
 			fs := flag.NewFlagSet("api", flag.ExitOnError)
-
-			// Deprecated flags.
-			fs.Duration("uno-listener-start-timeout", time.Duration(10)*time.Second, "Time limit for restarting the LibreOffice")
-			fs.Int64("uno-listener-restart-threshold", 10, "Conversions limit after which the LibreOffice listener is restarted - 0 means no restart")
-			fs.Bool("unoconv-disable-listener", false, "Do not start a long-running listener - save resources in detriment of unitary performance")
-
-			var err error
-			err = multierr.Append(err, fs.MarkDeprecated("uno-listener-start-timeout", "use the libreOffice-start-timeout property instead"))
-			err = multierr.Append(err, fs.MarkDeprecated("uno-listener-restart-threshold", "use the libreOffice-restart-after property instead"))
-			err = multierr.Append(err, fs.MarkDeprecated("unoconv-disable-listener", "use the libreOffice-auto-start property instead"))
-
-			if err != nil {
-				panic(fmt.Errorf("create deprecated flags for the LibreOffice module: %v", err))
-			}
-
 			fs.Int64("libreoffice-restart-after", 10, "Number of conversions after which LibreOffice will automatically restart. Set to 0 to disable this feature")
 			fs.Bool("libreoffice-auto-start", false, "Automatically launch LibreOffice upon initialization if set to true; otherwise, LibreOffice will start at the time of the first conversion")
 			fs.Duration("libreoffice-start-timeout", time.Duration(10)*time.Second, "Maximum duration to wait for LibreOffice to start or restart")
@@ -123,7 +107,7 @@ func (a *Api) Provision(ctx *gotenberg.Context) error {
 	a.args = libreOfficeArguments{
 		binPath:      libreOfficeBinPath,
 		unoBinPath:   unoBinPath,
-		startTimeout: flags.MustDeprecatedDuration("uno-listener-start-timeout", "libreoffice-start-timeout"),
+		startTimeout: flags.MustDuration("libreoffice-start-timeout"),
 	}
 
 	// Logger.
@@ -139,7 +123,7 @@ func (a *Api) Provision(ctx *gotenberg.Context) error {
 
 	// Process.
 	a.libreOffice = newLibreOfficeProcess(a.args)
-	a.supervisor = gotenberg.NewProcessSupervisor(a.logger, a.libreOffice, flags.MustDeprecatedInt64("uno-listener-restart-threshold", "libreoffice-restart-after"))
+	a.supervisor = gotenberg.NewProcessSupervisor(a.logger, a.libreOffice, flags.MustInt64("libreoffice-restart-after"))
 
 	return nil
 }
@@ -204,46 +188,6 @@ func (a *Api) Stop(ctx context.Context) error {
 // Metrics returns the metrics.
 func (a *Api) Metrics() ([]gotenberg.Metric, error) {
 	return []gotenberg.Metric{
-		// TODO: remove deprecated.
-		{
-			Name:        "unoconv_active_instances_count",
-			Description: "Current number of active unoconv instances - deprecated.",
-			Read: func() float64 {
-				return 1
-			},
-		},
-		// TODO: remove deprecated.
-		{
-			Name:        "libreoffice_listener_active_instances_count",
-			Description: "Current number of active LibreOffice listener instances - deprecated.",
-			Read: func() float64 {
-				return 1
-			},
-		},
-		// TODO: remove deprecated.
-		{
-			Name:        "unoconv_listener_active_instances_count",
-			Description: "Current number of active unoconv listener instances- deprecated.",
-			Read: func() float64 {
-				return 1
-			},
-		},
-		// TODO: remove deprecated.
-		{
-			Name:        "libreoffice_listener_queue_length",
-			Description: "Current number of processes in the LibreOffice listener queue - deprecated, prefer libreoffice_requests_queue_size.",
-			Read: func() float64 {
-				return float64(a.supervisor.ReqQueueSize())
-			},
-		},
-		// TODO: remove deprecated.
-		{
-			Name:        "unoconv_listener_queue_length",
-			Description: "Current number of processes in the queue - deprecated, prefer libreoffice_requests_queue_size.",
-			Read: func() float64 {
-				return float64(a.supervisor.ReqQueueSize())
-			},
-		},
 		{
 			Name:        "libreoffice_requests_queue_size",
 			Description: "Current number of LibreOffice conversion requests waiting to be treated.",

pkg/modules/libreoffice/api/api_test.go

@@ -284,41 +284,16 @@ func TestApi_Metrics(t *testing.T) {
 		t.Fatalf("expected no error but got: %v", err)
 	}
 
-	if len(metrics) != 7 {
-		t.Fatalf("expected %d metrics, but got %d", 7, len(metrics))
+	if len(metrics) != 2 {
+		t.Fatalf("expected %d metrics, but got %d", 2, len(metrics))
 	}
 
 	actual := metrics[0].Read()
-	if actual != float64(1) {
-		t.Errorf("expected %f for unoconv_active_instances_count, but got %f", float64(1), actual)
-	}
-
-	actual = metrics[1].Read()
-	if actual != float64(1) {
-		t.Errorf("expected %f for libreoffice_listener_active_instances_count, but got %f", float64(1), actual)
-	}
-
-	actual = metrics[2].Read()
-	if actual != float64(1) {
-		t.Errorf("expected %f for unoconv_listener_active_instances_count, but got %f", float64(1), actual)
-	}
-
-	actual = metrics[3].Read()
-	if actual != float64(10) {
-		t.Errorf("expected %f for libreoffice_listener_queue_length, but got %f", float64(10), actual)
-	}
-
-	actual = metrics[4].Read()
-	if actual != float64(10) {
-		t.Errorf("expected %f for unoconv_listener_queue_length, but got %f", float64(10), actual)
-	}
-
-	actual = metrics[5].Read()
 	if actual != float64(10) {
 		t.Errorf("expected %f for libreoffice_requests_queue_size, but got %f", float64(10), actual)
 	}
 
-	actual = metrics[6].Read()
+	actual = metrics[1].Read()
 	if actual != float64(0) {
 		t.Errorf("expected %f for libreoffice_restarts_count, but got %f", float64(0), actual)
 	}

pkg/modules/libreoffice/routes.go

@@ -24,25 +24,19 @@ func convertRoute(libreOffice libreofficeapi.Uno, engine gotenberg.PdfEngine) ap
 
 			// Let's get the data from the form and validate them.
 			var (
-				inputPaths         []string
-				landscape          bool
-				nativePageRanges   string
-				nativePdfA1aFormat bool
-				nativePdfFormat    string
-				pdfFormat          string
-				pdfa               string
-				pdfua              bool
-				nativePdfFormats   bool
-				merge              bool
+				inputPaths       []string
+				landscape        bool
+				nativePageRanges string
+				pdfa             string
+				pdfua            bool
+				nativePdfFormats bool
+				merge            bool
 			)
 
 			err := ctx.FormData().
 				MandatoryPaths(libreOffice.Extensions(), &inputPaths).
 				Bool("landscape", &landscape, false).
 				String("nativePageRanges", &nativePageRanges, "").
-				Bool("nativePdfA1aFormat", &nativePdfA1aFormat, false).
-				String("nativePdfFormat", &nativePdfFormat, "").
-				String("pdfFormat", &pdfFormat, "").
 				String("pdfa", &pdfa, "").
 				Bool("pdfua", &pdfua, false).
 				Bool("nativePdfFormats", &nativePdfFormats, true).
@@ -52,42 +46,8 @@ func convertRoute(libreOffice libreofficeapi.Uno, engine gotenberg.PdfEngine) ap
 				return fmt.Errorf("validate form data: %w", err)
 			}
 
-			// FIXME: deprecated.
-			// pdfa > nativePdfFormat > pdfFormat > nativePdfA1aFormat.
-			var (
-				actualPdfArchive string
-				nativeFormats    bool
-			)
-
-			if nativePdfA1aFormat {
-				ctx.Log().Warn("'nativePdfA1aFormat' is deprecated; prefer the 'pdfa' form field instead")
-				actualPdfArchive = gotenberg.PdfA1a
-				nativeFormats = true
-			}
-
-			if pdfFormat != "" {
-				ctx.Log().Warn("'pdfFormat' is deprecated; prefer the 'pdfa' form field instead")
-				actualPdfArchive = pdfFormat
-				nativeFormats = false
-			}
-
-			if nativePdfFormat != "" {
-				ctx.Log().Warn("'nativePdfFormat' is deprecated; prefer the 'pdfa' form field instead")
-				actualPdfArchive = nativePdfFormat
-				nativeFormats = true
-			}
-
-			if pdfa != "" {
-				actualPdfArchive = pdfa
-				nativeFormats = nativePdfFormats
-			}
-
-			if pdfua {
-				nativeFormats = nativePdfFormats
-			}
-
 			pdfFormats := gotenberg.PdfFormats{
-				PdfA:  actualPdfArchive,
+				PdfA:  pdfa,
 				PdfUa: pdfua,
 			}
 
@@ -101,7 +61,7 @@ func convertRoute(libreOffice libreofficeapi.Uno, engine gotenberg.PdfEngine) ap
 					PageRanges: nativePageRanges,
 				}
 
-				if nativeFormats {
+				if nativePdfFormats {
 					options.PdfFormats = pdfFormats
 				}
 
@@ -132,7 +92,7 @@ func convertRoute(libreOffice libreofficeapi.Uno, engine gotenberg.PdfEngine) ap
 				// Now, let's check if the client want to convert this result
 				// PDF to specific PDF formats.
 				zeroValued := gotenberg.PdfFormats{}
-				if !nativeFormats && pdfFormats != zeroValued {
+				if !nativePdfFormats && pdfFormats != zeroValued {
 					convertInputPath := outputPath
 					convertOutputPath := ctx.GeneratePath(".pdf")
 
@@ -169,7 +129,7 @@ func convertRoute(libreOffice libreofficeapi.Uno, engine gotenberg.PdfEngine) ap
 			// Ok, we don't have to merge the PDFs. Let's check if the client
 			// want to convert each PDF to a specific PDF format.
 			zeroValued := gotenberg.PdfFormats{}
-			if !nativeFormats && pdfFormats != zeroValued {
+			if !nativePdfFormats && pdfFormats != zeroValued {
 				convertOutputPaths := make([]string, len(outputPaths))
 
 				for i, outputPath := range outputPaths {

pkg/modules/libreoffice/routes_test.go

@@ -88,9 +88,12 @@ func TestConvertRoute(t *testing.T) {
 					"document.docx": "/document.docx",
 				})
 				ctx.SetValues(map[string][]string{
-					"pdfFormat": {
+					"pdfa": {
 						"foo",
 					},
+					"nativePdfFormats": {
+						"false",
+					},
 				})
 				return ctx
 			}(),
@@ -120,9 +123,12 @@ func TestConvertRoute(t *testing.T) {
 					"document.docx": "/document.docx",
 				})
 				ctx.SetValues(map[string][]string{
-					"pdfFormat": {
+					"pdfa": {
 						gotenberg.PdfA1a,
 					},
+					"nativePdfFormats": {
+						"false",
+					},
 				})
 				return ctx
 			}(),
@@ -209,7 +215,7 @@ func TestConvertRoute(t *testing.T) {
 			expectOutputPathsCount: 2,
 		},
 		{
-			scenario: "success with non-native PDF/A (single file)",
+			scenario: "success with non-native PDF/A & PDF/UA (single file)",
 			ctx: func() *api.ContextMock {
 				ctx := &api.ContextMock{Context: new(api.Context)}
 				ctx.SetFiles(map[string]string{
@@ -219,6 +225,9 @@ func TestConvertRoute(t *testing.T) {
 					"pdfa": {
 						gotenberg.PdfA1a,
 					},
+					"pdfua": {
+						"true",
+					},
 					"nativePdfFormats": {
 						"false",
 					},
@@ -243,31 +252,19 @@ func TestConvertRoute(t *testing.T) {
 			expectOutputPathsCount: 1,
 		},
 		{
-			scenario: "success with every non-native PDF/A & PDF/UA form fields (single file)",
+			scenario: "success with native PDF/A & PDF/UA (single file)",
 			ctx: func() *api.ContextMock {
 				ctx := &api.ContextMock{Context: new(api.Context)}
 				ctx.SetFiles(map[string]string{
 					"document.docx": "/document.docx",
 				})
 				ctx.SetValues(map[string][]string{
-					"nativePdfA1aFormat": {
-						"true",
-					},
-					"pdfFormat": {
-						gotenberg.PdfA1a,
-					},
-					"nativePdfFormat": {
-						gotenberg.PdfA1a,
-					},
 					"pdfa": {
 						gotenberg.PdfA1a,
 					},
 					"pdfua": {
 						"true",
 					},
-					"nativePdfFormats": {
-						"false",
-					},
 				})
 				return ctx
 			}(),
@@ -469,7 +466,7 @@ func TestConvertRoute(t *testing.T) {
 			expectOutputPathsCount: 1,
 		},
 		{
-			scenario: "success with non-native PDF/A (merge)",
+			scenario: "success with non-native PDF/A & PDF/UA (merge)",
 			ctx: func() *api.ContextMock {
 				ctx := &api.ContextMock{Context: new(api.Context)}
 				ctx.SetFiles(map[string]string{
@@ -483,6 +480,53 @@ func TestConvertRoute(t *testing.T) {
 					"pdfa": {
 						gotenberg.PdfA1a,
 					},
+					"pdfua": {
+						"true",
+					},
+					"nativePdfFormats": {
+						"false",
+					},
+				})
+				return ctx
+			}(),
+			libreOffice: &libreofficeapi.ApiMock{
+				PdfMock: func(ctx context.Context, logger *zap.Logger, inputPath, outputPath string, options libreofficeapi.Options) error {
+					return nil
+				},
+				ExtensionsMock: func() []string {
+					return []string{".docx"}
+				},
+			},
+			engine: &gotenberg.PdfEngineMock{
+				MergeMock: func(ctx context.Context, logger *zap.Logger, inputPaths []string, outputPath string) error {
+					return nil
+				},
+				ConvertMock: func(ctx context.Context, logger *zap.Logger, formats gotenberg.PdfFormats, inputPath, outputPath string) error {
+					return nil
+				},
+			},
+			expectError:            false,
+			expectHttpError:        false,
+			expectOutputPathsCount: 1,
+		},
+		{
+			scenario: "success with non-native PDF/A & PDF/UA (merge)",
+			ctx: func() *api.ContextMock {
+				ctx := &api.ContextMock{Context: new(api.Context)}
+				ctx.SetFiles(map[string]string{
+					"document.docx":  "/document.docx",
+					"document2.docx": "/document2.docx",
+				})
+				ctx.SetValues(map[string][]string{
+					"merge": {
+						"true",
+					},
+					"pdfa": {
+						gotenberg.PdfA1a,
+					},
+					"pdfua": {
+						"true",
+					},
 					"nativePdfFormats": {
 						"false",
 					},