-
-
Notifications
You must be signed in to change notification settings - Fork 50
[18.0][FIX] edi_storage_oca: add event listener #226
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ArnauCForgeFlow
wants to merge
1
commit into
OCA:18.0
Choose a base branch
from
ForgeFlow:18.0-edi_storage_oca-add_listener
base: 18.0
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| # Copyright 2021 ForgeFlow S.L. (https://www.forgeflow.com) | ||
| # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). | ||
|
|
||
| import functools | ||
| import os | ||
| from pathlib import PurePath | ||
|
|
||
| from odoo.addons.component.core import Component | ||
|
|
||
| from .. import utils | ||
|
|
||
|
|
||
| class EdiStorageListener(Component): | ||
| _name = "edi.storage.component.listener" | ||
| _inherit = "base.event.listener" | ||
|
|
||
| def _move_file(self, storage, from_dir_str, to_dir_str, filename): | ||
| from_dir = PurePath(from_dir_str) | ||
| to_dir = PurePath(to_dir_str) | ||
| # - storage.list_files now includes path in fs_storage, breaking change | ||
| # - we remove path | ||
| files = utils.list_files(storage, from_dir.as_posix()) | ||
| files = [os.path.basename(f) for f in files] | ||
| if filename not in files: | ||
| return False | ||
| self._add_post_commit_hook( | ||
| utils.move_files, | ||
| storage, | ||
| [(from_dir / filename).as_posix()], | ||
| to_dir.as_posix(), | ||
| ) | ||
| return True | ||
|
|
||
| def _add_post_commit_hook( | ||
| self, move_func, storage, sftp_filepath, sftp_destination_path | ||
| ): | ||
| """Add hook after commit to move the file when transaction is over.""" | ||
| self.env.cr.postcommit.add( | ||
| functools.partial(move_func, storage, sftp_filepath, sftp_destination_path) | ||
| ) | ||
|
|
||
| def on_edi_exchange_done(self, record): | ||
| storage = record.storage_id | ||
| res = False | ||
| if record.direction == "input" and storage: | ||
| file = record.exchange_filename | ||
| pending_dir = record.type_id._storage_fullpath( | ||
| record.backend_id.input_dir_pending | ||
| ).as_posix() | ||
| done_dir = record.type_id._storage_fullpath( | ||
| record.backend_id.input_dir_done | ||
| ).as_posix() | ||
| error_dir = record.type_id._storage_fullpath( | ||
| record.backend_id.input_dir_error | ||
| ).as_posix() | ||
| if not done_dir: | ||
| return res | ||
| res = self._move_file(storage, pending_dir, done_dir, file) | ||
| if not res: | ||
| # If a file previously failed it should have been previously | ||
| # moved to the error dir, therefore it is not present in the | ||
| # pending dir and we need to retry from error dir. | ||
| res = self._move_file(storage, error_dir, done_dir, file) | ||
| return res | ||
|
|
||
| def on_edi_exchange_error(self, record): | ||
| storage = record.storage_id | ||
| res = False | ||
| if record.direction == "input" and storage: | ||
| file = record.exchange_filename | ||
| pending_dir = record.type_id._storage_fullpath( | ||
| record.backend_id.input_dir_pending | ||
| ).as_posix() | ||
| error_dir = record.type_id._storage_fullpath( | ||
| record.backend_id.input_dir_error | ||
| ).as_posix() | ||
| if error_dir: | ||
| res = self._move_file(storage, pending_dir, error_dir, file) | ||
| return res |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| from . import test_edi_backend_storage | ||
| from . import test_exchange_type | ||
| from . import test_edi_event_listenner |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| # Copyright 2026 ForgeFlow S.L. (https://www.forgeflow.com) | ||
| # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). | ||
|
|
||
| import base64 | ||
| from unittest import mock | ||
|
|
||
| from odoo.addons.edi_component_oca.tests.common import ( | ||
| EDIBackendCommonComponentRegistryTestCase, | ||
| ) | ||
| from odoo.addons.edi_component_oca.tests.fake_components import FakeInputProcess | ||
|
|
||
| LISTENER_MOCK_PATH = ( | ||
| "odoo.addons.edi_storage_oca.models.edi_event_listener.EdiStorageListener" | ||
| ) | ||
|
|
||
|
|
||
| class EDIBackendTestCase(EDIBackendCommonComponentRegistryTestCase): | ||
| @classmethod | ||
| def setUpClass(cls): | ||
| super().setUpClass() | ||
| cls._load_module_components(cls, "edi_storage_oca") | ||
| cls._build_components( | ||
| cls, | ||
| FakeInputProcess, | ||
| ) | ||
| vals = { | ||
| "model": cls.partner._name, | ||
| "res_id": cls.partner.id, | ||
| "exchange_file": base64.b64encode(b"1234"), | ||
| } | ||
| cls.record = cls.backend.create_record("test_csv_input", vals) | ||
| cls.fake_move_args = None | ||
|
|
||
| @classmethod | ||
| def _get_backend(cls): | ||
| return cls.env.ref("edi_storage_oca.demo_edi_backend_storage") | ||
|
|
||
| def setUp(self): | ||
| super().setUp() | ||
| FakeInputProcess.reset_faked() | ||
|
|
||
| def _move_file_mocked(self, *args): | ||
| self.fake_move_args = [*args] | ||
| if not all([*args]): | ||
| return False | ||
| return True | ||
|
|
||
| def _mock_listener_move_file(self): | ||
| return mock.patch(LISTENER_MOCK_PATH + "._move_file", self._move_file_mocked) | ||
|
|
||
| def test_01_process_record_success(self): | ||
| with self._mock_listener_move_file(): | ||
| self.record.write( | ||
| { | ||
| "edi_exchange_state": "input_received", | ||
| "storage_id": self.backend.storage_id.id, | ||
| } | ||
| ) | ||
| self.record.action_exchange_process() | ||
| storage, from_dir_str, to_dir_str, filename = self.fake_move_args | ||
| self.assertEqual(storage, self.backend.storage_id) | ||
| self.assertEqual(from_dir_str, self.backend.input_dir_pending) | ||
| self.assertEqual(to_dir_str, self.backend.input_dir_done) | ||
| self.assertEqual(filename, self.record.exchange_filename) | ||
|
|
||
| def test_02_process_record_with_error(self): | ||
| with self._mock_listener_move_file(): | ||
| self.record.write( | ||
| { | ||
| "edi_exchange_state": "input_received", | ||
| "storage_id": self.backend.storage_id.id, | ||
| } | ||
| ) | ||
| self.record._set_file_content("TEST %d" % self.record.id) | ||
| self.record.with_context( | ||
| test_break_process="OOPS! Something went wrong :(" | ||
| ).action_exchange_process() | ||
| storage, from_dir_str, to_dir_str, filename = self.fake_move_args | ||
| self.assertEqual(storage, self.backend.storage_id) | ||
| self.assertEqual(from_dir_str, self.backend.input_dir_pending) | ||
| self.assertEqual(to_dir_str, self.backend.input_dir_error) | ||
| self.assertEqual(filename, self.record.exchange_filename) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@etobella Could we ask for your opinion here? there was a regression, but to revert it we need a new dependency... not sure if you would prefer this in a glue module. Thoughts?