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 💪

pacodelaluna · 2024-12-26T20:10:25Z

I have finally succeeded in fixing the specs!
Also, following the suggestion of @RachL , I put back the permalink-related form in the Primary Details form. The UX has then changed a bit, as you are now activating the permalink-related form from the Admin Only tab, so you will not notice directly that something has changed. Tell me if it is fine for you.

pacodelaluna · 2024-12-26T20:12:07Z

app/controllers/admin/enterprises_controller.rb

+      if params[:is_primary_producer].present?
+        @enterprise.is_primary_producer = params[:is_primary_producer]
+      end
+      @enterprise.sells = params[:enterprise_sells] if params[:enterprise_sells].present?


As the values can come from 2 different sides (Primary Details tab or Admin only tab), we need to control the presence of the value first.

pacodelaluna · 2024-12-26T20:12:58Z

app/views/admin/enterprises/form/_permalink.html.haml

@@ -15,8 +15,6 @@
        %span.unavailable.hidden{data: { "permalink-target": "unavailable" }}
          = t('js.unavailable')
          %i.icon-remove-sign
-
-  - unless @enterprise.sells == 'none'


This control is already present on line 2.

pacodelaluna · 2024-12-26T20:14:16Z

app/webpacker/controllers/admin_only_controller.js

@@ -0,0 +1,29 @@
+import { Controller } from "stimulus";
+
+export default class extends Controller {


We need to cut down the initial logic into a new JS controller handling the Admin Only tab.

pacodelaluna · 2024-12-26T20:15:38Z

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


I put the limit at 128 chars as it seems enough, but it can be of course changed in case.

pacodelaluna · 2024-12-26T20:16:22Z

spec/system/admin/enterprises_spec.rb

    uncheck 'enterprise_is_primary_producer'
+    click_button 'Update'


We need now to save explicitly the data before switching the tabs.

RachL · 2024-12-27T12:15:12Z

@pacodelaluna I'm not sure I understand

as you are now activating the permalink-related form from the Admin Only tab, so you will not notice directly that something has changed.

Can you provide more detail?

Many thanks for the rest! The PR is now in code review

RachL · 2024-12-27T13:08:15Z

@pacodelaluna when saving it sometimes tells me the business address company can't be blank:

Yet business address company is in another tab, and it's often not the address that is missing but the company legal name.

In production, this info is mandatory but only if you edit the tab, if you are on another tab, the tab is not checking the value of other tabs. Is this something we are introducing here?

If yes, maybe we shouldn't try something new here and keep it simple / not add a new tab. I feel like we are spending a lot of time on this new tab, when we only need one new field 😅

Also FYI the PR needs a rebase.

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 added 6 commits December 21, 2024 15:44

Add external_billing_id field on enterprises table

7430738

Add new field on enterprise admin form

a233b46

Deal with translations

1ec970e

Handle the async action for entreprises sells field changes

71014f3

Move admin_only tab upper

9344e5e

Add unit tests for admin entreprises changes

4596148

pacodelaluna added 4 commits December 21, 2024 15:44

Add external_billing_id field on revenues_by_hub report

a1dacc3

Repair field placeholder translation

ea61712

Repair specs

46cfc6a

Put back permalink fields on primary details panel

d90ca53

pacodelaluna force-pushed the add-external-billing-id-on-enterprises branch from 193be72 to d90ca53 Compare December 22, 2024 11:41

Fix spec

b40e8a1

pacodelaluna force-pushed the add-external-billing-id-on-enterprises branch from 737f40b to b40e8a1 Compare December 22, 2024 12:43

pacodelaluna added 2 commits December 23, 2024 08:04

Add spinner

16506c4

Use params value only if present

5cd50b1

pacodelaluna force-pushed the add-external-billing-id-on-enterprises branch 3 times, most recently from 738bf85 to 3ddc08c Compare December 26, 2024 17:51

Do explicit save in specs when switching tabs

3230159

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

pacodelaluna commented Dec 26, 2024

View reviewed changes

RachL added the pr-staged-fr staging.coopcircuits.fr label Dec 27, 2024

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

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 Dec 26, 2024

pacodelaluna Dec 26, 2024

pacodelaluna Dec 26, 2024

pacodelaluna Dec 26, 2024

pacodelaluna Dec 26, 2024

pacodelaluna Dec 26, 2024

RachL commented Dec 27, 2024 •

edited

Loading

RachL commented Dec 27, 2024

		@@ -0,0 +1,29 @@
		import { Controller } from "stimulus";

		export default class extends Controller {

		uncheck 'enterprise_is_primary_producer'
		click_button 'Update'

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 Dec 26, 2024

pacodelaluna Dec 26, 2024

Choose a reason for hiding this comment

pacodelaluna Dec 26, 2024

Choose a reason for hiding this comment

pacodelaluna Dec 26, 2024

Choose a reason for hiding this comment

pacodelaluna Dec 26, 2024

Choose a reason for hiding this comment

pacodelaluna Dec 26, 2024

Choose a reason for hiding this comment

RachL commented Dec 27, 2024 • edited Loading

RachL commented Dec 27, 2024

pacodelaluna commented Nov 16, 2024 •

edited

Loading

pacodelaluna commented Dec 9, 2024 •

edited

Loading

RachL commented Dec 13, 2024 •

edited

Loading

RachL commented Dec 27, 2024 •

edited

Loading