[jwrosewell]

Problem

The IP Intelligence on-premise specification gives "Balanced" as the default performance profile (ip-intelligence-on-premise.md, the Performance Profile row at line 259). The C library's default IP Intelligence configuration is the Balanced one, fiftyoneDegreesIpiDefaultConfig = { FIFTYONE_DEGREES_IPI_CONFIG_BALANCED } (51degrees-cxx src/ipi/ipi.c lines 237 to 257, at the commit the cxx submodule points to). Python's IP Intelligence engine defaulted to "LowMemory".

The Device Detection engine gets the same change in #57. This pull request is separate because it is a different package.

What I checked on rc

All line numbers in this section are on rc at 0507eef, in ip-intelligence/fiftyone_ipintelligence_onpremise/src/fiftyone_ipintelligence_onpremise/ipintelligence_onpremise.py.

• IpIntelligenceOnPremise.__init__ took performance_profile="LowMemory" (line 60).
• The profile switch (lines 152 to 168) starts from ConfigIpiSwig() and always calls one profile setter. It maps "Balanced" to config.setBalanced(), which in the C++ wrapper copies fiftyoneDegreesIpiBalancedConfig (ConfigIpi.cpp lines 53 to 55). So no new mapping was needed.
• IpIntelligenceOnPremisePipelineBuilder, IpIntelligencePipelineBuilder and PipelineBuilder.build_from_configuration hold no default of their own. They pass their settings to that constructor, so every route, a configuration file's elementParameters included, took the engine's default. A configuration file can set the profile by name, as performance_profile.
• The docstrings in the engine and both builders listed the profile names with no default. No readme names the default profile, and the examples set a profile by name.

Change

• IpIntelligenceOnPremise takes performance_profile="Balanced" (line 60).
• The performance_profile docstrings in ipintelligence_onpremise.py, ipintelligence_onpremise_pipelinebuilder.py and fiftyone_ipintelligence/ipintelligence_pipelinebuilder.py say Balanced is the default, as in the native code.

A caller that names a profile keeps what they asked for. Only a caller that left the profile unset sees a difference. Concurrency is not changed.

For the release notes

The IP Intelligence on-premise engine now uses the Balanced performance profile by default, instead of LowMemory, as the specification and the C library give. Anyone relying on the default will use more memory after upgrading, because Balanced loads some collections into memory and caches others, where LowMemory reads everything from the data file. Pass performance_profile="LowMemory" to keep the previous behaviour.

Tests

ip-intelligence/fiftyone_ipintelligence_onpremise/tests/test_performance_profile_default.py uses the free ASN data file at cxx/data/ip-intelligence/51Degrees-IPIV4AsnIpiV41.ipi, through the get_asn_data_file_path helper the existing tests use. It skips with a message naming the download scripts when that file is not there.

This test is indirect. Python keeps no name for the profile in use, so the tests compare the configuration the engine gives the native code (engine.config) with the settings the native code gives each profile. They compare, for seven collections (strings, maps, graphs, profile groups, profile offsets, property types and the graph), whether each is loaded into memory and how many items it caches. Those are what a profile sets, and Balanced and LowMemory differ in all seven. MaxPerformance and LowMemory have the same collection settings, as do Balanced and BalancedTemp, so the test cannot tell either pair apart.

The other four collections the configuration exposes, being components, properties, values and profiles, are left out, because asking for them corrupts the heap. In the committed wrapper ipi_python_wrap.cxx, ConfigIpiSwig.getComponents, getProperties, getValues and getProfiles return a reference to a setting the configuration owns, but mark it SWIG_POINTER_OWN, so Python frees memory it does not own. The other seven getters do not. The cause is in the C library's SWIG files, where %newobject getComponents, getProperties, getProfiles and getValues are written without a class name (src/common/MetaData.i lines 41 to 44), so they also catch the getters of the same names in src/ipi/ConfigIpi.i, which return references. My first run of this test called them and stopped with Windows fatal exception 0xc0000374, which is heap corruption. The Device Detection wrapper returns its collection settings by value, so it is not affected.

• test_balanced_and_low_memory_differ checks the two profiles' settings differ, so the comparisons below can tell them apart.
• test_engine_defaults_use_balanced builds the engine at its defaults in a pipeline and checks its settings are the Balanced ones.
• test_builder_defaults_use_balanced does the same through IpIntelligenceOnPremisePipelineBuilder.
• test_each_named_profile_is_used checks each of the five names gives the settings its own setter gives.

Verification

From ip-intelligence/fiftyone_ipintelligence_onpremise, on Windows with Python 3.14.7 and the Visual Studio 2022 Build Tools. I installed the pipeline packages and fiftyone_ipintelligence_shared from this checkout into a virtual environment, built this package's native module with pip install -e ., and downloaded the ASN file and the free Lite file with cxx/data/get-data-files.ps1. The existing tests read the Lite file through IPINTELLIGENCEDATAFILE, set to cxx/data/ip-intelligence/51Degrees-LiteV41.ipi. Then I ran

python -m pytest tests -p no:cacheprovider -q -rfEs

• rc's engine and builder with rc's tests (the new file left out with --ignore) gave 16 passed.
• rc's engine and builder with the new file gave 2 failed, 2 passed, 5 subtests passed. The failures are test_engine_defaults_use_balanced and test_builder_defaults_use_balanced, which found the LowMemory settings, being nothing loaded and no cache.
• This branch gave 20 passed, 5 subtests passed, being the 16 existing tests and the 4 new ones, with the existing tests now running on the Balanced profile.

I did not run the IP Intelligence cloud, translation or examples tests locally, and CI does not run the build and test on a draft.

Remaining

• The Device Detection engine's default is changed in #57.
• The four IP Intelligence configuration getters that corrupt the heap need fixing in the C library's SWIG files and the wrapper generating again. Nothing in this repository calls them, but a caller's own code can.