[Fixes #14042] deprecate overwrite_existing_layers in favor of action…

[mattiagiupponi]

… usage

Checklist

Reviewing is a process done by project maintainers, mostly on a volunteer basis. We try to keep the overhead as small as possible and appreciate if you help us to do so by completing the following items. Feel free to ask in a comment if you have troubles with any of them.

For all pull requests:

• Confirm you have read the contribution guidelines
• You have sent a Contribution Licence Agreement (CLA) as necessary (not required for small changes, e.g., fixing typos in the documentation)
• Make sure the first PR targets the master branch, eventual backports will be managed later. This can be ignored if the PR is fixing an issue that only happens in a specific branch, but not in newer ones.

The following are required only for core and extension modules (they are welcomed, but not required, for contrib modules):

• There is a ticket in https://github.com/GeoNode/geonode/issues describing the issue/improvement/feature (a notable exemption is, changes not visible to end-users)
• The issue connected to the PR must have Labels and Milestone assigned
• PR for bug fixes and small new features are presented as a single commit
• PR title must be in the form "[Fixes #<issue_number>] Title of the PR"
• New unit tests have been added covering the changes, unless there is an explanation on why the tests are not necessary/implemented

Submitting the PR does not require you to check all items, but by the time it gets merged, they should be either satisfied or inapplicable.

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refactors the layer import and overwrite mechanism by deprecating a dedicated boolean flag in favor of a more generalized action parameter. This change simplifies the API and internal logic for handling resource replacement, making the system more consistent and extensible. It also includes an update to enable asynchronous signals in the development environment.

Highlights

• Deprecation of overwrite_existing_layer: The boolean flag overwrite_existing_layer has been deprecated and removed across the codebase. Overwrite functionality is now determined by checking if the action parameter is set to ira.REPLACE.value.
• Refactored Overwrite Logic: All relevant handlers and serializers have been updated to use the action parameter (specifically ira.REPLACE.value) to determine if an existing layer should be overwritten, streamlining the import process.
• Asynchronous Signals Enabled: The ASYNC_SIGNALS setting in the development environment configuration has been enabled, changing its value from False to True.
• Test Suite Updates: End-to-end and unit tests have been modified to reflect the change from overwrite_existing_layer to the action: "replace" parameter, ensuring continued functionality.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• .env_dev
  • Updated ASYNC_SIGNALS from False to True.
• geonode/upload/api/serializer.py
  • Removed overwrite_existing_layer from OverwriteImporterSerializer fields.
  • Removed the overwrite_existing_layer boolean field definition.
• geonode/upload/celery_tasks.py
  • Replaced overwrite_existing_layer check with action == ira.REPLACE.value in publish_resource.
  • Replaced overwrite_existing_layer check with action == ira.REPLACE.value in create_geonode_resource.
  • Replaced overwrite_existing_layer check with exec_object.action == ira.REPLACE.value in rollback.
• geonode/upload/handlers/common/metadata.py
  • Removed overwrite_existing_layer from the parameters extracted by extract_params_from_data.
• geonode/upload/handlers/common/raster.py
  • Imported ImporterRequestAction as ira.
  • Removed overwrite_existing_layer from the parameters extracted by extract_params_from_data.
  • Replaced overwrite_existing_layer check with _exec.action == ira.REPLACE.value in import_resource.
  • Replaced overwrite_existing_layer check with _exec.action == ira.REPLACE.value in create_geonode_resource.
  • Replaced overwrite_existing_layer check with _exec.action == ira.REPLACE.value in overwrite_geonode_resource.
• geonode/upload/handlers/common/remote.py
  • Removed overwrite_existing_layer from the parameters extracted by extract_params_from_data.
  • Replaced overwrite_existing_layer check with _exec.action == ira.REPLACE.value in import_resource.
  • Replaced overwrite_existing_layer check with _exec.action == ira.REPLACE.value in overwrite_geonode_resource.
• geonode/upload/handlers/common/serializer.py
  • Removed overwrite_existing_layer from RemoteResourceSerializer fields.
  • Removed the overwrite_existing_layer boolean field definition.
• geonode/upload/handlers/common/vector.py
  • Removed overwrite_existing_layer from the parameters extracted by extract_params_from_data.
  • Replaced overwrite_existing_layer check with _exec.action == ira.REPLACE.value in import_resource.
  • Replaced overwrite_existing_layer check with _exec.action == ira.REPLACE.value in create_geonode_resource.
  • Replaced overwrite_existing_layer check with _exec.action == ira.REPLACE.value in overwrite_geonode_resource.
• geonode/upload/handlers/shapefile/handler.py
  • Replaced overwrite_existing_layer check with action == ira.REPLACE.value in has_serializer.
  • Removed overwrite_existing_layer from the parameters extracted by extract_params_from_data.
• geonode/upload/handlers/shapefile/serializer.py
  • Removed overwrite_existing_layer from ShapeFileSerializer fields.
  • Removed the overwrite_existing_layer boolean field definition from ShapeFileSerializer.
  • Removed overwrite_existing_layer from OverwriteShapeFileSerializer fields.
  • Removed the overwrite_existing_layer boolean field definition from OverwriteShapeFileSerializer.
• geonode/upload/handlers/tiles3d/handler.py
  • Removed overwrite_existing_layer from the parameters extracted by extract_params_from_data.
  • Replaced overwrite_existing_layer check with _exec.action == ira.REPLACE.value in import_resource.
• geonode/upload/handlers/xml/serializer.py
  • Removed overwrite_existing_layer from MetadataFileSerializer fields.
  • Removed the overwrite_existing_layer boolean field definition.
• geonode/upload/orchestrator.py
  • Removed unused ast import.
  • Refactored get_serializer to use _data.get("action") == ira.REPLACE.value for overwrite flow instead of is_overwrite_flow.
• geonode/upload/tests/end2end/test_end2end.py
  • Updated test_import_gpkg_overwrite to use action: "replace" instead of overwrite_existing_layer: True.
  • Updated test_import_geojson_overwrite to use action: "replace" instead of overwrite_existing_layer: True.
  • Updated test_import_csv_overwrite to use action: "replace" instead of overwrite_existing_layer: True.
  • Updated test_import_kml_overwrite to use action: "replace" instead of overwrite_existing_layer: True.
  • Updated test_import_shapefile_overwrite to use action: "replace" instead of overwrite_existing_layer: True.
  • Updated test_import_raster_overwrite to use action: "replace" instead of overwrite_existing_layer: True.
  • Updated test_import_3dtiles_overwrite to use action: "replace" instead of overwrite_existing_layer: True.
• geonode/upload/tests/unit/test_task.py
  • Removed commented-out overwrite_existing_layer from input_params in setUp.
  • Added action="replace" and removed overwrite_existing_layer from input_params in test_publish_resource_if_overwrite_should_call_the_publishing.
  • Added action="replace" and removed overwrite_existing_layer from input_params in test_publish_resource_if_overwrite_should_not_call_the_publishing.
  • Removed commented-out overwrite_existing_layer from input_params in test_create_geonode_resource.
  • Removed commented-out overwrite_existing_layer from input_params in setUp for TestRollback.

Activity

• Confirmed reading the contribution guidelines.
• Confirmed sending a Contribution Licence Agreement (CLA) as necessary.
• Confirmed the first PR targets the master branch.
• Confirmed a ticket exists in GitHub issues describing the issue/improvement/feature.
• Confirmed the issue connected to the PR has Labels and Milestone assigned.
• Confirmed PR for bug fixes and small new features are presented as a single commit.
• Confirmed PR title is in the form "[Fixes #<issue_number>] Title of the PR".

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request effectively deprecates the overwrite_existing_layers parameter in favor of using action: 'replace', which improves the clarity and consistency of the API. The changes are well-implemented across the codebase, including handlers, serializers, and tests. I've found one minor issue where some leftover code from the old implementation can be removed to make the code cleaner. Overall, this is a great improvement.

[codecov]

Codecov Report

❌ Patch coverage is 73.68421% with 15 lines in your changes missing coverage. Please review.
✅ Project coverage is 74.55%. Comparing base (15d278b) to head (c3f5cba).
⚠️ Report is 6 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #14043      +/-   ##
==========================================
- Coverage   74.58%   74.55%   -0.04%     
==========================================
  Files         951      951              
  Lines       57245    57255      +10     
  Branches     7771     7779       +8     
==========================================
- Hits        42694    42684      -10     
- Misses      12833    12848      +15     
- Partials     1718     1723       +5     

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[mattiagiupponi]

test is failing, in order to enable the replace we need to wait the merge of #14041