csadewa

csadewa

Hi, i am currently in the middle of refactoring effort, and part of that effort was changing file/schema/module namespace into a more proper namespace, for example changing a module from LoadService.V2.Loads.Schema.JobPreassignedTransporterCompanyData to LoadService.V2.DeliveryOrderManagement.Schema.JobPreassignedTransporterCompanyData.

I found a lot of difficulties in trying to find out which file / module that call LoadService.V2.Loads.Schema.JobPreassignedTransporterCompanyData previously, especially because there is a lot of way to alias a module and call it in Elixir, for example:

  1. direct call (easiest to find):
LoadService.V2.Loads.Schema.JobPreassignedTransporterCompanyData.some_function
  1. alias direct module:
alias LoadService.V2.Loads.Schema.JobPreassignedTransporterCompanyData
JobPreassignedTransporterCompanyData.some_function
  1. alias parent module
alias LoadService.V2.Loads.Schema
Schema.JobPreassignedTransporterCompanyData.some_function

What better ways i could do to make this process of finding & renaming module namespace better?

Showing Posts 1 to 5

Sebb

Sebb

Refactoring is not the sweet spot of elixir, having no static typing and no refactoring tools (that I know of).

1+2 should be easy to handle with search+replace, right?
3 I avoid exactly because of this. The best I can come up with is

  • search alias LoadService.V2.Loads.Schema in all files
  • replace it if JobPreassignedTransporterCompanyData is the only thing using Schema here, otherwith add the new module alias

I’m curious if there are better solutions…

csadewa

csadewa OP

Yes, that’s what i currently do also, try to find & replace manually as best as i could, but it get really hard if the module name is short & common (for example, i have schema called Job).

one idea i was thinking of if there is some way to manipulate compiler trace feature to help discover which file/module that call a particular file / module. but i sadly lacking a lot of knowledge to do it in short time period.

(Now that i think about it, maybe i could use elixir warning message when trying to call a undefined function/module as indicator, let me check a bit and see it).

Sebb

Sebb

Yes, I think this is just very hard (or rather tedious) to do without any tool-support.
Can’t say anything about how a refactoring tool could be implemented in Elixir, because its just beyond me.

csadewa

csadewa OP

Oh, turn out warning emitted by compiler is useful for catching when refactoring namespace if there’s any missed rename. i currently would

mix clean
mix test &> mix_test_result.txt
# wait a bit + check mix_test_result.txt periodically to ensure all code + test code get compiled, but skip actual testing execution to get compiler warning

if i miss some renaming, it would show up in mix_test_result.txt like

warning: LoadService.V2.DeliveryOrderManagement.Schema.JobPreassignedTransporterCompanyData.btms_send_transporter_exclusive_shipment_notifications/2 is undefined or private
lib/load_service/v2/loads/api/delivery_order.ex:2614: LoadService.V2.Loads.API.DeliveryOrder.save_delivery_order/3

csadewa

csadewa OP

A bit of update, turn out that mix has a functionality for tracking caller of a particular module via xref, it can be used to note which file that need to be changed, though it does require full recompilation of code from every invocation, like

mix xref callers LoadService.V2.Loads.JobPreassignedTransporterCompanyData
(..recompile whole application)
lib/load_service/v2/delivery_order_management/jobs.ex (runtime)
lib/load_service/v2/loads/api/delivery_order.ex (runtime)
lib/load_service/v2/oban/job.ex (runtime)

— All posts loaded —

Where Next? Top

Trending in Questions Top

itzmidinesh
Hi all, I’m working on a Phoenix project where I need to make external HTTP requests and I’m trying to choose between Req and HTTPoison....
New
yarrichar
I’m very new to Elixir, so sorry if this is a silly question: I am wondering what happens to the mailbox of a process when the machine i...
New
Hellowman
Hello everyone! I am new to coding with Elixir/Erlang. And i am looking for some utilities for fuzzing testing like AFL++. Does anyone ...
New
pragdave
How do I tell Hologram not to escape HTML when substituting into templates? {Textile.render(@product.long_description)} escapes the HTM...
New
Fl4m3Ph03n1x
Background When trying to execute mix release on a Windows 11 machine for a Phoenix project I get the following error: * assembling mark...
New
rlipscombe
I’d like to create a file with 600 permissions (rw-------), but there’s a race condition if I create it and then change the permissions. ...
New
mandar1045
I load tested a plain Phoenix chat app backed by Postgres with 100 million messages in it, everything on default settings, to see what br...
New

Other Trending Topics Top

dominicletz
Hey there, I haven’t seen a list of useful Elixir specific skills for the popular AI tools yet so I’m starting one here with my first. ...
New
raa-ziq
Hi everyone :waving_hand: I wanted to share something I’ve been building — NowBlind, a random chat app designed to help people discover ...
New
mudasobwa
I fully migrated to my own harness from Anthropic/Gemini and I think it’s time to share it. Welcome DSH, the DeepSeek Harness, fully writ...
New
OndrejValenta
(I just needed to vent somewhere and LinkedIn is full of hope, or hype, I’m not sure which exactly) AI dream has many faces, but general...
New
kip
Localize is the next generation localisation library for Elixir. Think of it as ex_cldr version 3.0. The first version will be released ...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews