Mark deprecated functionality with C++ attributes and resolve internal usage of deprecated functions by matejk · Pull Request #4551 · pocoproject/poco

matejk · 2024-05-08T11:27:19Z

Closes #4426.

aleks-f

I am not sure if @deprecated is needed/used by PocoDoc, @obiltschnig would know

Foundation/include/Poco/ClassLibrary.h

Foundation/include/Poco/LocalDateTime.h

Crypto/include/Poco/Crypto/EVPPKey.h

+//class [[deprecated]] ECKey;
+//class [[deprecated]] RSAKey;


Crypto/include/Poco/Crypto/RSAKey.h

 class X509Certificate;
 class PKCS12Container;

+//class [[deprecated]] RSAKey;


Crypto/include/Poco/Crypto/ECKey.h

 class X509Certificate;
 class PKCS12Container;

+//class [[deprecated]] ECKey;


Crypto/include/Poco/Crypto/RSADigestEngine.h

 	};

-	//@ deprecated
+	//[[deprecated]] RSADigestEngine(const RSAKey& key, DigestType digestType = DIGEST_SHA1);


MongoDB/include/Poco/MongoDB/InsertRequest.h

 namespace Poco {
 namespace MongoDB {

+//class [[deprecated]] InsertRequest;


MongoDB/include/Poco/MongoDB/RequestMessage.h

 namespace Poco {
 namespace MongoDB {

+//class [[deprecated]] RequestMessage;


MongoDB/include/Poco/MongoDB/ResponseMessage.h

 namespace Poco {
 namespace MongoDB {

+//class [[deprecated]] ResponseMessage;


MongoDB/include/Poco/MongoDB/QueryRequest.h

 namespace Poco {
 namespace MongoDB {

+//class [[deprecated]] QueryRequest;


MongoDB/include/Poco/MongoDB/Cursor.h

 namespace Poco {
 namespace MongoDB {

+//class [[deprecated]] Cursor;


MongoDB/include/Poco/MongoDB/GetMoreRequest.h

 namespace Poco {
 namespace MongoDB {

+//class [[deprecated]] GetMoreRequest;


matejk · 2024-07-15T10:09:50Z

Functionality that was marked as deprecated with comments is now marked as such with C++ attribute with a few exceptions:

Deprecating OpenSSL non-EVP functionality is moved to ticket OpenSSL: Remove deprecated non EVP code #4602.
Deprecating old MongoDB network protocol is moved to ticket MongoDB: deprecate old (pre MongoDB 5.1) network protocol #4603.

Usage of deprecated functions and classes in Poco code is replaced with non-deprecated variants.

Unit tests for deprecated functionality are disabled by default and can be enabled with POCO_TEST_DEPRECATED.

Some C++ code modernisation was done in the code while resolving deprecations.

@aleks-f, @obiltschnig

aleks-f

Overall looks good, than you. I'm just thinking it would be good to have a single place to disarm warnings somehow.

aleks-f · 2024-07-16T12:49:41Z

Data/src/SQLChannel.cpp

 	{
 		try
 		{
+			sleepTime = 100;


warning: likely to cause merge conflict with #4530

MongoDB/include/Poco/MongoDB/MessageHeader.h

matejk · 2024-07-16T13:28:57Z

Overall looks good, than you. I'm just thinking it would be good to have a single place to disarm warnings somehow.

Do you mean deprecation warnings that will be seen by the users of Poco? Do we want to disarm them?

aleks-f · 2024-07-16T17:05:40Z

Overall looks good, than you. I'm just thinking it would be good to have a single place to disarm warnings somehow.

Do you mean deprecation warnings that will be seen by the users of Poco? Do we want to disarm them?

I foresee some annoyance if we swamp the build with deprecation warnings. In any case, I think there should be an easy way to disable them.

)

…eate valid binaries.

…4426)

…ions/classes (#4426)

…ty (#4426)

…PRECATED is enabled (#4426)

…OCO_TEST_DEPRECATED is enabled (#4426)

…able deprecation warnings in applications (#4426)

matejk · 2024-07-25T08:50:57Z

Overall looks good, than you. I'm just thinking it would be good to have a single place to disarm warnings somehow.

Do you mean deprecation warnings that will be seen by the users of Poco? Do we want to disarm them?

I foresee some annoyance if we swamp the build with deprecation warnings. In any case, I think there should be an easy way to disable them.

Introduced a macro POCO_DEPRECATED instead of using [[deprecated]] directly. An application can define POCO_SILENCE_DEPRECATED to have POCO_DEPRECATED defined to an empty define.

IMO the branch is ready to be merged to main.

@obiltschnig, @aleks-f, any objections?

…instantiation warnings on windows

…lve internal usage of deprecated functions (#4551) * enh(poco): Replace deprecated comments with C++ deprecated attribute. * enh(Poco): Replace some deprecated functionality in Poco sources. (#4426) * enh(Poco): Replace more deprecated functionality in Poco sources. (#4426) * fix(CMake): Variable BUILD_SHARED_LIBS must be defined properly to create valid binaries. * enh: Code improvements done while resolving deprecated functionality (#4426) * Un-deprecate LocalDateTme (#4426) * enh(Poco): Replace usage of deprecated functionality with other functions/classes (#4426) * chore(SSL): temporarily un-deprecate SSL-related functionality (#4426) * chore(SSL): temporarily un-deprecate old MongoDB protocol functionality (#4426) * enh(Poco): Minor Hash improvements (#4426) * enh(Foundation): Compile deprecated hash tests only when POCO_TEST_DEPRECATED is enabled (#4426) * enh(Net): Compile deprecated Socket::select functionality only when POCO_TEST_DEPRECATED is enabled (#4426) * enh(Bonjour): Replace deprecated Socket::select with PollSet (#4426) * enh(Poco): Introduce POCO_DEPRECATED macro to have the ability to disable deprecation warnings in applications (#4426) * test(ODBC): add few asserts to testStoredProcedureDynamicVar * fix(ODBC): rename DynamicAny -> DynamicVar in tests * fix(ODBC): make Dignostics static members inline to prevent explicit instantiation warnings on windows --------- Co-authored-by: Alex Fabijanic <alex@pocoproject.org>

matejk self-assigned this May 8, 2024

matejk force-pushed the 4426-deprecated-functionality branch 12 times, most recently from f2c5384 to bc4b50a Compare May 10, 2024 13:20

aleks-f requested changes May 12, 2024

View reviewed changes

Foundation/include/Poco/ClassLibrary.h Outdated Show resolved Hide resolved

matejk force-pushed the 4426-deprecated-functionality branch from bc4b50a to 3999dcd Compare May 13, 2024 11:31

matejk commented May 17, 2024

View reviewed changes

Foundation/include/Poco/LocalDateTime.h Show resolved Hide resolved

matejk commented May 17, 2024

View reviewed changes

Crypto/include/Poco/Crypto/EVPPKey.h Outdated Show resolved Hide resolved

matejk force-pushed the 4426-deprecated-functionality branch 2 times, most recently from f63afd3 to da8037a Compare May 24, 2024 07:33

matejk force-pushed the 4426-deprecated-functionality branch from da8037a to fe5f2b5 Compare July 12, 2024 09:26

github-advanced-security bot found potential problems Jul 12, 2024

View reviewed changes

matejk requested review from aleks-f and obiltschnig July 15, 2024 10:04

aleks-f approved these changes Jul 16, 2024

View reviewed changes

matejk added 3 commits July 25, 2024 09:55

enh(poco): Replace deprecated comments with C++ deprecated attribute.

ef1897d

enh(Poco): Replace some deprecated functionality in Poco sources. (#4426

4d4f2bf

)

enh(Poco): Replace more deprecated functionality in Poco sources. (#4426

e87a2d9

)

matejk added 11 commits July 25, 2024 09:55

fix(CMake): Variable BUILD_SHARED_LIBS must be defined properly to cr…

16002c1

…eate valid binaries.

enh: Code improvements done while resolving deprecated functionality (#…

e9b26ee

…4426)

Un-deprecate LocalDateTme (#4426)

c4e01e1

enh(Poco): Replace usage of deprecated functionality with other funct…

5587305

…ions/classes (#4426)

chore(SSL): temporarily un-deprecate SSL-related functionality (#4426)

f8c0ce0

chore(SSL): temporarily un-deprecate old MongoDB protocol functionali…

5d72939

…ty (#4426)

enh(Poco): Minor Hash improvements (#4426)

2e9cb49

enh(Foundation): Compile deprecated hash tests only when POCO_TEST_DE…

f9fc941

…PRECATED is enabled (#4426)

enh(Net): Compile deprecated Socket::select functionality only when P…

0df7424

…OCO_TEST_DEPRECATED is enabled (#4426)

enh(Bonjour): Replace deprecated Socket::select with PollSet (#4426)

671c8a9

enh(Poco): Introduce POCO_DEPRECATED macro to have the ability to dis…

ad8c34f

…able deprecation warnings in applications (#4426)

matejk force-pushed the 4426-deprecated-functionality branch from 105597b to ad8c34f Compare July 25, 2024 08:46

matejk and others added 3 commits July 25, 2024 15:24

test(ODBC): add few asserts to testStoredProcedureDynamicVar

17c4574

fix(ODBC): rename DynamicAny -> DynamicVar in tests

4159992

fix(ODBC): make Dignostics static members inline to prevent explicit …

9de2d60

…instantiation warnings on windows

matejk merged commit 91bea7c into main Jul 29, 2024

matejk deleted the 4426-deprecated-functionality branch July 29, 2024 06:38

Conversation

matejk commented May 8, 2024

Uh oh!

aleks-f left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

matejk commented Jul 15, 2024

Uh oh!

aleks-f left a comment

Choose a reason for hiding this comment

Uh oh!

aleks-f Jul 16, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

matejk commented Jul 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aleks-f commented Jul 16, 2024

Uh oh!

matejk commented Jul 25, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

matejk commented Jul 16, 2024 •

edited

Loading