Add external billing id on enterprises #12980

pacodelaluna · 2024-11-16T15:47:12Z

What? Why?

Closes As a super admin, I should see a field I can use to link enterprise with my invoicing software #12942

The objective is to improve the links between OFN enterprises and external billing tools, through the admin reports.

What should we test?

Check you can add an ID on an enterprise profile
This ID can be found on the revenue by hub report
This ID is available on v0 API / report section, as well as the enterprise database
Super admin can change the ID as many times as they want
Super admin can't add spaces to this ID
Several enterprises can have the same ID
Enterprise owner / managers don't see this field

Release notes

Changelog Category (reviewers may add a label for the release notes):

User facing changes
API changes (V0, V1, DFC or Webhook)

Add external billing id on enterprises

The title of the pull request will be included in the release notes.

Documentation updates

No. The tip section should explain the objective of the new field with enough details.

pacodelaluna · 2024-11-28T21:28:30Z

I think that I have completed the objective of the ticket.

You can add the External Billing Id information on the enterprise:

And it is displayed on the Revenues By Hub report:

Please tell me if I missed something.

pacodelaluna · 2024-11-28T23:20:34Z

Oops, it seems I have some failing specs, working on it asap.

RachL · 2024-11-29T08:26:08Z

LGTM! Many thanks @pacodelaluna ❤️

pacodelaluna · 2024-12-09T21:27:14Z

I have tried to update the specs in order to pass the tests, but I am facing issues setting up Cuprite on my local machine.
I am trying to run it on my local Docker env, and I am not able to find a way to run it properly...
Still having this issue:

It seems I am not able to force a specific port for Capybara, not sure why as I am updating the configuration to block the port.

Maybe I am not looking in the good direction.
Does anybody know if someone else got this error already?

RachL · 2024-12-13T20:05:56Z

@pacodelaluna FYI the OFN docker image changed recently: #12905

RachL · 2024-12-13T20:11:55Z

@pacodelaluna sorry me again. Apologies I didn't pay a close attention to the screenshot the first time, and now that i'm playing with it I'm noticing that you've moved fields in the admin section that should remain accessible to enterprise managers/owners:

These two need to stay in "primary details tab'.

dacook · 2024-12-17T06:04:30Z

Hi @pacodelaluna sorry that you're having issues with Cuprite. I don't have time to help until next year sorry, but you can try posting in Slack #dev channel in case someone else can help.

filipefurtad0 · 2024-12-18T14:44:28Z

Apologies, I see I must have overridden you on the staging-FR server. I hope I did not cause too much trouble 🙏

RachL · 2024-12-18T20:32:40Z

no don't worry @filipefurtad0 and I see I've forgotten to remove the label 🤦‍♀️ please use it as much as you need on your timezone. FR team is developing a tool to automate invoices to OFN users, and this PR is needed for the tests, so I will stage it again in the next couples of days, but again feel free to use the staging during your time 💪

This reverts commit 3230159.

This reverts commit 5cd50b1.

This reverts commit 16506c4.

This reverts commit b40e8a1.

This reverts commit d90ca53.

pacodelaluna · 2025-01-06T20:32:15Z

@RachL It was possible to move the Sells field as @dacook suggested it, without issues regarding the Permalink fields. I also commented on the ticket.

pacodelaluna · 2025-01-06T20:36:52Z

Maybe we can also move the triggered fields into a new Permalink & UID section, for clarity.

It is a 30 sec change, as you wish.

RachL · 2025-01-06T20:52:43Z

My comment was more about the fact that I find the UX a bit weird: a below field has an impact on another field which is located above it.

But let's keep it that way 👍 I've moved the PR to code review @pacodelaluna many thanks!!!!

dacook

Great, this looks like a nice tidy way to solve it in the end!

I have a couple of small suggestions, otherwise it's all good to go.

For the second reviewer: just review the full diff.

dacook · 2025-01-08T00:52:22Z

db/migrate/20241113185651_add_external_billing_id_on_enterprises.rb

@@ -0,0 +1,5 @@
+class AddExternalBillingIdOnEnterprises < ActiveRecord::Migration[7.0]
+  def change
+    add_column :enterprises, :external_billing_id, :string, limit: 128


Makes sense, I agree that there shouldn't be more than 128 chars in this field.
Scanning schema.rb, I see that most fields are set to 255 🤷 Probably it doesn't matter.

dacook · 2025-01-08T01:01:52Z

spec/serializers/api/admin/enterprise_serializer_spec.rb

+
+  context "when there is a external billing id" do
+    let(:enterprise) { create(:distributor_enterprise, external_billing_id: 'INV123456') }
+
+    it "includes URLs of image versions" do
+      serializer = Api::Admin::EnterpriseSerializer.new(enterprise)
+      expect(serializer.as_json[:external_billing_id]).to eq('INV123456')
+    end
+  end


Actually I think we don't really need an extra test for this, we could add the expectation to the first test in this file (because we don't need to test "when there is no billing id").
Would it be ok to change that? That would help avoid growing this file too much.

dacook · 2025-01-08T01:02:55Z

spec/system/admin/reports/revenues_by_hub_spec.rb

@@ -89,6 +90,7 @@
        "none",
        "none",
        "none",
+        "none",


This is an opportunity to test that it shows in the report, can it be added for one of the distributors?

pacodelaluna · 2025-01-08T22:20:23Z

@dacook I have just applied your suggestions about the specs, please tell me if it is ok now, thanks for your time.

mkllnk

Great, this is looking good now.

github-actions bot assigned pacodelaluna Nov 16, 2024

pacodelaluna marked this pull request as draft November 16, 2024 15:48

pacodelaluna removed their assignment Nov 16, 2024

pacodelaluna marked this pull request as ready for review November 28, 2024 21:25

pacodelaluna force-pushed the add-external-billing-id-on-enterprises branch 2 times, most recently from ccd284b to 193be72 Compare November 28, 2024 22:55

RachL assigned pacodelaluna Nov 29, 2024

RachL added pr-staged-fr staging.coopcircuits.fr and removed pr-staged-fr staging.coopcircuits.fr labels Dec 11, 2024

RachL added pr-staged-fr staging.coopcircuits.fr and removed pr-staged-fr staging.coopcircuits.fr labels Dec 16, 2024

RachL added pr-staged-fr staging.coopcircuits.fr and removed pr-staged-fr staging.coopcircuits.fr labels Dec 18, 2024

RachL removed the pr-staged-fr staging.coopcircuits.fr label Dec 18, 2024

pacodelaluna force-pushed the add-external-billing-id-on-enterprises branch 6 times, most recently from 3ddc08c to 3230159 Compare December 26, 2024 19:52

pacodelaluna added 16 commits January 6, 2025 21:24

Add unit tests for admin entreprises changes

a16f5b2

Add external_billing_id field on revenues_by_hub report

27fcf76

Repair field placeholder translation

ce7f041

Repair specs

d270dda

Put back permalink fields on primary details panel

dc07e5a

Fix spec

3d9793b

Add spinner

77ba7e0

Use params value only if present

7d37fcd

Do explicit save in specs when switching tabs

0511fc2

Revert "Do explicit save in specs when switching tabs"

129ceac

This reverts commit 3230159.

Revert "Use params value only if present"

a6990d3

This reverts commit 5cd50b1.

Revert "Add spinner"

905f535

This reverts commit 16506c4.

Revert "Fix spec"

980c510

This reverts commit b40e8a1.

Revert "Put back permalink fields on primary details panel"

47b3310

This reverts commit d90ca53.

Remove Admin Only tab logic

ba7db00

Isolate into an Admin Only section

3bcca1e

pacodelaluna force-pushed the add-external-billing-id-on-enterprises branch from ec546f5 to 3bcca1e Compare January 6, 2025 20:24

RachL added pr-staged-fr staging.coopcircuits.fr and removed pr-staged-fr staging.coopcircuits.fr labels Jan 6, 2025

dacook self-requested a review January 8, 2025 00:48

dacook requested changes Jan 8, 2025

View reviewed changes

pacodelaluna and others added 3 commits January 8, 2025 22:39

Improve specs

104a6f0

Merge branch 'master' into add-external-billing-id-on-enterprises

a15874d

Fix specs

33f7d8d

pacodelaluna force-pushed the add-external-billing-id-on-enterprises branch from 7d15401 to 33f7d8d Compare January 8, 2025 22:08

mkllnk approved these changes Jan 9, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add external billing id on enterprises #12980

Add external billing id on enterprises #12980

pacodelaluna commented Nov 16, 2024 •

edited

Loading

pacodelaluna commented Nov 28, 2024

pacodelaluna commented Nov 28, 2024

RachL commented Nov 29, 2024

pacodelaluna commented Dec 9, 2024 •

edited

Loading

RachL commented Dec 13, 2024

RachL commented Dec 13, 2024 •

edited

Loading

dacook commented Dec 17, 2024

filipefurtad0 commented Dec 18, 2024

RachL commented Dec 18, 2024

pacodelaluna commented Jan 6, 2025

pacodelaluna commented Jan 6, 2025

RachL commented Jan 6, 2025

dacook left a comment

dacook Jan 8, 2025

dacook Jan 8, 2025

dacook Jan 8, 2025

pacodelaluna commented Jan 8, 2025

mkllnk left a comment

@@ @@ -89,6 +90,7 @@ @@
                       "none",
                       "none",
                       "none",
+                      "none",

Add external billing id on enterprises #12980

Are you sure you want to change the base?

Add external billing id on enterprises #12980

Conversation

pacodelaluna commented Nov 16, 2024 • edited Loading

What? Why?

What should we test?

Release notes

Documentation updates

pacodelaluna commented Nov 28, 2024

pacodelaluna commented Nov 28, 2024

RachL commented Nov 29, 2024

pacodelaluna commented Dec 9, 2024 • edited Loading

RachL commented Dec 13, 2024

RachL commented Dec 13, 2024 • edited Loading

dacook commented Dec 17, 2024

filipefurtad0 commented Dec 18, 2024

RachL commented Dec 18, 2024

pacodelaluna commented Jan 6, 2025

pacodelaluna commented Jan 6, 2025

RachL commented Jan 6, 2025

dacook left a comment

Choose a reason for hiding this comment

dacook Jan 8, 2025

Choose a reason for hiding this comment

dacook Jan 8, 2025

Choose a reason for hiding this comment

dacook Jan 8, 2025

Choose a reason for hiding this comment

pacodelaluna commented Jan 8, 2025

mkllnk left a comment

Choose a reason for hiding this comment

pacodelaluna commented Nov 16, 2024 •

edited

Loading

pacodelaluna commented Dec 9, 2024 •

edited

Loading

RachL commented Dec 13, 2024 •

edited

Loading