diff --git a/barcode_stock_product_multi_barcode/README.rst b/barcode_stock_product_multi_barcode/README.rst new file mode 100644 index 0000000..38102f7 --- /dev/null +++ b/barcode_stock_product_multi_barcode/README.rst @@ -0,0 +1,114 @@ +.. image:: https://odoo-community.org/readme-banner-image + :target: https://odoo-community.org/get-involved?utm_source=readme + :alt: Odoo Community Association + +=================================== +Barcode Stock Product Multi Barcode +=================================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:da420dd433e401420c1b36a9e23ac9cc31c21bf2895acfa62bc43c6a18c0b0d9 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fbarcode--interface-lightgray.png?logo=github + :target: https://github.com/OCA/barcode-interface/tree/18.0/barcode_stock_product_multi_barcode + :alt: OCA/barcode-interface +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/barcode-interface-18-0/barcode-interface-18-0-barcode_stock_product_multi_barcode + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/barcode-interface&target_branch=18.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module is the bridge between **multiple product barcodes** and the +**warehouse app**: it makes every barcode a product carries resolve to +the same move inside a picking. + +``product_multi_barcode`` lets a product hold several barcodes (its main +one plus alternates). ``barcode_stock`` only indexes the main barcode +and the packagings, so scanning an alternate barcode inside a picking is +rejected even though the product is on the move. This module loads the +alternate barcodes of the products in the current picking and indexes +them, so a scan of any of them matches the same move. + +It installs itself as soon as both ``barcode_stock`` and +``product_multi_barcode`` are installed, and neither needs the other +without it. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +Install ``barcode_stock`` and ``product_multi_barcode``. The module +installs itself automatically. + +Give a product several barcodes through ``product_multi_barcode``. +Inside the warehouse app, scanning any of them in a picking now resolves +to the same move as the main barcode. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Binhex + +Contributors +------------ + +- Binhex + +Maintainers +----------- + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +.. |maintainer-antoniodavid| image:: https://github.com/antoniodavid.png?size=40px + :target: https://github.com/antoniodavid + :alt: antoniodavid +.. |maintainer-szalatyzuzanna| image:: https://github.com/szalatyzuzanna.png?size=40px + :target: https://github.com/szalatyzuzanna + :alt: szalatyzuzanna + +Current `maintainers `__: + +|maintainer-antoniodavid| |maintainer-szalatyzuzanna| + +This module is part of the `OCA/barcode-interface `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/barcode_stock_product_multi_barcode/__init__.py b/barcode_stock_product_multi_barcode/__init__.py new file mode 100644 index 0000000..1f7d345 --- /dev/null +++ b/barcode_stock_product_multi_barcode/__init__.py @@ -0,0 +1,2 @@ +# Copyright 2026 Binhex +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). diff --git a/barcode_stock_product_multi_barcode/__manifest__.py b/barcode_stock_product_multi_barcode/__manifest__.py new file mode 100644 index 0000000..0843fae --- /dev/null +++ b/barcode_stock_product_multi_barcode/__manifest__.py @@ -0,0 +1,24 @@ +{ + "name": "Barcode Stock Product Multi Barcode", + "version": "18.0.1.0.0", + "category": "Inventory/Logistics", + "summary": "Recognize alternate product barcodes in the warehouse app", + "author": "Binhex, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/barcode-interface", + "maintainers": ["antoniodavid", "szalatyzuzanna"], + "license": "AGPL-3", + "depends": [ + "barcode_stock", + "product_multi_barcode", + ], + "assets": { + "web.assets_backend": [ + "barcode_stock_product_multi_barcode/static/src/js/product_multi_barcode.esm.js", + ], + "web.assets_unit_tests": [ + "barcode_stock_product_multi_barcode/static/tests/**/*", + ], + }, + "installable": True, + "auto_install": True, +} diff --git a/barcode_stock_product_multi_barcode/pyproject.toml b/barcode_stock_product_multi_barcode/pyproject.toml new file mode 100644 index 0000000..4231d0c --- /dev/null +++ b/barcode_stock_product_multi_barcode/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/barcode_stock_product_multi_barcode/readme/CONTRIBUTORS.md b/barcode_stock_product_multi_barcode/readme/CONTRIBUTORS.md new file mode 100644 index 0000000..432194c --- /dev/null +++ b/barcode_stock_product_multi_barcode/readme/CONTRIBUTORS.md @@ -0,0 +1 @@ +* Binhex diff --git a/barcode_stock_product_multi_barcode/readme/DESCRIPTION.md b/barcode_stock_product_multi_barcode/readme/DESCRIPTION.md new file mode 100644 index 0000000..aeb93dd --- /dev/null +++ b/barcode_stock_product_multi_barcode/readme/DESCRIPTION.md @@ -0,0 +1,13 @@ +This module is the bridge between **multiple product barcodes** and the +**warehouse app**: it makes every barcode a product carries resolve to the same +move inside a picking. + +`product_multi_barcode` lets a product hold several barcodes (its main one plus +alternates). `barcode_stock` only indexes the main barcode and the packagings, +so scanning an alternate barcode inside a picking is rejected even though the +product is on the move. This module loads the alternate barcodes of the products +in the current picking and indexes them, so a scan of any of them matches the +same move. + +It installs itself as soon as both ``barcode_stock`` and +``product_multi_barcode`` are installed, and neither needs the other without it. diff --git a/barcode_stock_product_multi_barcode/readme/USAGE.md b/barcode_stock_product_multi_barcode/readme/USAGE.md new file mode 100644 index 0000000..79fccc6 --- /dev/null +++ b/barcode_stock_product_multi_barcode/readme/USAGE.md @@ -0,0 +1,6 @@ +Install ``barcode_stock`` and ``product_multi_barcode``. The module installs +itself automatically. + +Give a product several barcodes through ``product_multi_barcode``. Inside the +warehouse app, scanning any of them in a picking now resolves to the same move +as the main barcode. diff --git a/barcode_stock_product_multi_barcode/static/description/icon.png b/barcode_stock_product_multi_barcode/static/description/icon.png new file mode 100644 index 0000000..3a0328b Binary files /dev/null and b/barcode_stock_product_multi_barcode/static/description/icon.png differ diff --git a/barcode_stock_product_multi_barcode/static/description/index.html b/barcode_stock_product_multi_barcode/static/description/index.html new file mode 100644 index 0000000..d286cb5 --- /dev/null +++ b/barcode_stock_product_multi_barcode/static/description/index.html @@ -0,0 +1,451 @@ + + + + + +Barcode Stock Product Multi Barcode + + + +
+ + + +Odoo Community Association + +
+

Barcode Stock Product Multi Barcode

+ +

Beta License: AGPL-3 OCA/barcode-interface Translate me on Weblate Try me on Runboat

+

This module is the bridge between multiple product barcodes and the +warehouse app: it makes every barcode a product carries resolve to +the same move inside a picking.

+

product_multi_barcode lets a product hold several barcodes (its main +one plus alternates). barcode_stock only indexes the main barcode +and the packagings, so scanning an alternate barcode inside a picking is +rejected even though the product is on the move. This module loads the +alternate barcodes of the products in the current picking and indexes +them, so a scan of any of them matches the same move.

+

It installs itself as soon as both barcode_stock and +product_multi_barcode are installed, and neither needs the other +without it.

+

Table of contents

+ +
+

Usage

+

Install barcode_stock and product_multi_barcode. The module +installs itself automatically.

+

Give a product several barcodes through product_multi_barcode. +Inside the warehouse app, scanning any of them in a picking now resolves +to the same move as the main barcode.

+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Binhex
  • +
+
+
+

Contributors

+
    +
  • Binhex
  • +
+
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

Current maintainers:

+

antoniodavid szalatyzuzanna

+

This module is part of the OCA/barcode-interface project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+
+ + diff --git a/barcode_stock_product_multi_barcode/static/src/js/product_multi_barcode.esm.js b/barcode_stock_product_multi_barcode/static/src/js/product_multi_barcode.esm.js new file mode 100644 index 0000000..0bd34f0 --- /dev/null +++ b/barcode_stock_product_multi_barcode/static/src/js/product_multi_barcode.esm.js @@ -0,0 +1,77 @@ +import {BarcodeScannerState} from "@barcode_stock/js/services/barcode_scanner_state.esm"; +import {patch} from "@web/core/utils/patch"; + +/** + * Recognize every barcode a product carries in the warehouse app. + * + * `product_multi_barcode` lets a product hold several barcodes (its main one + * plus alternates). `barcode_stock` only indexes the main barcode and the + * packagings, so scanning an alternate barcode inside a picking is rejected + * even though the product is on the move. This bridge loads the alternate + * barcodes of the products in the current picking and indexes them so a scan + * of any of them resolves to the same move. + */ +patch(BarcodeScannerState.prototype, { + /** + * @override + * Drop the alternate barcodes of the previous picking so a new one starts + * clean. + */ + reset() { + super.reset(...arguments); + this.alternateBarcodes = []; + }, + + /** + * @override + * Load the alternate barcodes of the products in the picking and keep them + * so `buildIndexes` can map each one to its product. + * + * The previous picking's barcodes are dropped before the base preload: + * `super.preloadPicking` builds the indexes itself, and that build must + * not map barcodes that belong to the picking being left behind. + */ + async preloadPicking(pickingId) { + // Clear before the super call so its `buildIndexes` cannot see them. + this.alternateBarcodes = []; + const snapshot = await super.preloadPicking(pickingId); + const productIds = Object.keys(this.productsById).map(Number); + if (productIds.length) { + try { + this.alternateBarcodes = await this.orm.searchRead( + "product.barcode", + [["product_id", "in", productIds]], + ["name", "product_id"] + ); + } catch { + // A user without read access to product.barcode still loads the + // picking; it just falls back to main barcodes and packagings. + this.alternateBarcodes = []; + } + } + this.buildIndexes(); + return snapshot; + }, + + /** + * @override + * Map every alternate barcode to its product so a scan of any of them + * matches the same move as the main barcode. + */ + buildIndexes() { + const indexes = super.buildIndexes(...arguments); + for (const barcode of this.alternateBarcodes || []) { + const productId = barcode.product_id?.[0]; + const code = barcode.name; + if (!productId || !code) { + continue; + } + indexes.barcodeToProductIds[code] = [ + ...(indexes.barcodeToProductIds[code] || []), + productId, + ]; + } + this.indexes = indexes; + return indexes; + }, +}); diff --git a/barcode_stock_product_multi_barcode/static/tests/product_multi_barcode.test.js b/barcode_stock_product_multi_barcode/static/tests/product_multi_barcode.test.js new file mode 100644 index 0000000..688f646 --- /dev/null +++ b/barcode_stock_product_multi_barcode/static/tests/product_multi_barcode.test.js @@ -0,0 +1,210 @@ +import "@barcode_stock_product_multi_barcode/js/product_multi_barcode.esm"; +import {describe, expect, test} from "@odoo/hoot"; +import {BarcodeScannerState} from "@barcode_stock/js/services/barcode_scanner_state.esm"; + +// A product with a main barcode and two alternates, on a move of a picking. +const PRODUCT = {id: 40, barcode: "2300001000008", display_name: "SunPaper 100"}; +const ALTERNATES = [ + {id: 1, name: "2300001000009", product_id: [40, "SunPaper 100"]}, + {id: 2, name: "2300001000010", product_id: [40, "SunPaper 100"]}, +]; +const MOVE = { + id: 100, + product_id: [40, "SunPaper 100"], + product_uom_qty: 10, + quantity: 10, + location_id: [8, "WH/Stock"], + location_dest_id: [4, "Partners/Vendors"], +}; + +const PICKING = { + id: 1, + name: "WH/IN/00001", + picking_type_id: [1, "Receipts"], + location_id: [4, "Partners/Vendors"], + location_dest_id: [8, "WH/Stock"], + state: "assigned", +}; + +// A second picking holds another product, with an alternate of its own. +const PICKING_2 = {...PICKING, id: 2, name: "WH/IN/00002"}; +const PRODUCT_2 = {id: 41, barcode: "2300002000003", display_name: "SunPaper 200"}; +const ALTERNATES_2 = [{id: 3, name: "2300002000004", product_id: [41, "SunPaper 200"]}]; +const MOVE_2 = {...MOVE, id: 101, product_id: [41, "SunPaper 200"]}; + +function stateWithAlternates() { + const state = new BarcodeScannerState({}); + state.productsById = {40: PRODUCT}; + state.moves = [MOVE]; + state.packagings = []; + state.alternateBarcodes = ALTERNATES; + state.buildIndexes(); + return state; +} + +describe("ProductMultiBarcode", () => { + test("an alternate barcode resolves to the same move as the main one", () => { + const state = stateWithAlternates(); + const main = state.getMoveCandidatesForBarcode(PRODUCT.barcode); + const alt = state.getMoveCandidatesForBarcode(ALTERNATES[0].name); + expect(alt.map((m) => m.id)).toEqual(main.map((m) => m.id)); + expect(alt[0].id).toBe(MOVE.id); + }); + + test("every alternate barcode maps to the product", () => { + const state = stateWithAlternates(); + for (const alt of ALTERNATES) { + const productId = state.indexes.barcodeToProductIds[alt.name]?.[0]; + expect(productId).toBe(PRODUCT.id); + } + }); + + test("a barcode with no alternate still resolves through the main barcode", () => { + const state = stateWithAlternates(); + expect(state.getMoveCandidatesForBarcode(PRODUCT.barcode)[0].id).toBe(MOVE.id); + }); + + test("an unknown barcode yields no candidates", () => { + const state = stateWithAlternates(); + expect(state.getMoveCandidatesForBarcode("9999999999999")).toEqual([]); + }); + + test("preloadPicking loads and indexes the alternate barcodes", async () => { + const orm = { + searchRead(model) { + if (model === "stock.picking") { + return [ + { + id: 1, + name: "WH/IN/00001", + picking_type_id: [1, "Receipts"], + location_id: [4, "Partners/Vendors"], + location_dest_id: [8, "WH/Stock"], + state: "assigned", + }, + ]; + } + if (model === "stock.move") { + return [MOVE]; + } + if (model === "stock.move.line") { + return []; + } + if (model === "product.packaging") { + return []; + } + if (model === "product.barcode") { + return ALTERNATES; + } + if (model === "stock.lot") { + return []; + } + return []; + }, + read(model, ids) { + if (model === "stock.picking.type") { + return [ + { + id: 1, + code: "incoming", + use_existing_lots: false, + use_create_lots: true, + }, + ]; + } + if (model === "product.product") { + return ids.map((id) => ({...PRODUCT, id})); + } + return []; + }, + // The preload asks stock.lot for its expiry fields; none here. + call() { + return {}; + }, + }; + const state = new BarcodeScannerState(orm); + await state.preloadPicking(1); + expect(state.alternateBarcodes).toHaveLength(2); + expect(state.getMoveCandidatesForBarcode(ALTERNATES[0].name)[0].id).toBe( + MOVE.id + ); + }); + + test("switching pickings does not leak the previous alternate barcodes", async () => { + let barcodeSearches = 0; + let resolveAlternates = null; + let markAlternatesRequested = null; + const alternatesRequested = new Promise((resolve) => { + markAlternatesRequested = resolve; + }); + const orm = { + searchRead(model, domain) { + if (model === "stock.picking") { + return [domain[0][2] === PICKING.id ? PICKING : PICKING_2]; + } + if (model === "stock.move") { + return [domain[0][2] === PICKING.id ? MOVE : MOVE_2]; + } + if (model === "product.barcode") { + if (barcodeSearches++ === 0) { + return ALTERNATES; + } + // Hold the second picking's alternates: the base preload + // has built the indexes and the patch waits on this call. + markAlternatesRequested(); + return new Promise((resolve) => { + resolveAlternates = resolve; + }); + } + return []; + }, + read(model, ids) { + if (model === "stock.picking.type") { + return [ + { + id: 1, + code: "incoming", + use_existing_lots: false, + use_create_lots: true, + }, + ]; + } + if (model === "product.product") { + return ids.map((id) => (id === PRODUCT_2.id ? PRODUCT_2 : PRODUCT)); + } + return []; + }, + call() { + return {}; + }, + }; + const state = new BarcodeScannerState(orm); + await state.preloadPicking(PICKING.id); + expect(state.getMoveCandidatesForBarcode(ALTERNATES[0].name)[0].id).toBe( + MOVE.id + ); + + const switching = state.preloadPicking(PICKING_2.id); + await alternatesRequested; + // Snapshot the window before releasing the RPC: with the old ordering + // the base build has already indexed picking 1's codes against product + // 40, which picking 2 does not carry. Releasing the RPC first keeps a + // failing assertion from leaving the preload pending. + const leaked = { + first: state.indexes.barcodeToProductIds[ALTERNATES[0].name], + second: state.indexes.barcodeToProductIds[ALTERNATES[1].name], + }; + resolveAlternates(ALTERNATES_2); + await switching; + + expect(leaked.first).toBe(undefined); + expect(leaked.second).toBe(undefined); + expect(state.indexes.barcodeToProductIds[ALTERNATES_2[0].name]).toEqual([ + PRODUCT_2.id, + ]); + expect(state.getMoveCandidatesForBarcode(ALTERNATES_2[0].name)[0].id).toBe( + MOVE_2.id + ); + expect(state.indexes.barcodeToProductIds[ALTERNATES[0].name]).toBe(undefined); + }); +}); diff --git a/barcode_stock_product_multi_barcode/tests/__init__.py b/barcode_stock_product_multi_barcode/tests/__init__.py new file mode 100644 index 0000000..af4cbd1 --- /dev/null +++ b/barcode_stock_product_multi_barcode/tests/__init__.py @@ -0,0 +1,4 @@ +# Copyright 2026 Binhex +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import test_js diff --git a/barcode_stock_product_multi_barcode/tests/test_js.py b/barcode_stock_product_multi_barcode/tests/test_js.py new file mode 100644 index 0000000..535c426 --- /dev/null +++ b/barcode_stock_product_multi_barcode/tests/test_js.py @@ -0,0 +1,23 @@ +# Copyright 2026 Binhex +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from odoo.tests.common import HttpCase, tagged + + +@tagged("post_install", "-at_install") +class TestBarcodeStockProductMultiBarcodeJs(HttpCase): + """Run the module's JS unit tests (``static/tests``) in the browser. + + A Chrome/Chromium binary is required: without one the run is skipped, not + passed. + """ + + def test_js(self): + self.browser_js( + "/web/tests?headless&loglevel=2&preset=desktop&filter=ProductMultiBarcode", + "", + "", + login="admin", + success_signal="[HOOT] Test suite succeeded", + error_checker=lambda message: "[HOOT]" not in message, + )