|
jschell wrote: While you keep responding but fail to answer the original question
- how did you specifically measure the improvement?
- What was your specific improvement.?
Actually I did answer your questions. Perhaps you missed reading my reply of 27-Feb-2024 10.46. Here it is again:
Ravi Bhavnani wrote: By measuring our sprint velocity and bug counts.
The increase in sprint velocity showed we were able to release new and modified functionality consistently faster (without growing our team), and the reduction in issues per new feature/enhancement spoke to better code quality brought about by the increase in the number of unit tests. Defining our injected dependencies as interfaces (vs. concrete classes) makes it easier to write unit tests because it's trivial to mock them. This is especially true when many of our service dependencies are implemented by other teams.
/ravi
|
|
|
|
|
First of course those are not numbers.
Second I responded to you and said the following...
"Are you claiming that interfaces and nothing else reduced bug counts?"
Ravi Bhavnani wrote: The increase in sprint velocity showed we were able to release new and modified functionality
Yes one can modify coding practices and development processes to achieve various measurable benefits.
But you cannot due that solely by using interfaces.
Please read the Original Post.
It says nothing about a comprehensive rework of coding practices and development processes.
It says that nothing but requiring interfaces is being required.
|
|
|
|
|
jschell wrote: First of course those are not numbers.
Do you mean sprint velocity, code coverage and bug counts aren't numbers?
jschell wrote: But you cannot due that solely by using interfaces.
Correct. And I didn't imply you could. Read my comment of 17-Feb-24 13:11 again.
/ravi
|
|
|
|
|
Ravi Bhavnani wrote: Do you mean sprint velocity, code coverage and bug counts aren't numbers?
No. Those are measurable quantities which over time can reflect a change.
A number is 3. You could state that you improved 30%. Or that your average bug count went from 30 to 3.
Those are numbers.
Ravi Bhavnani wrote: Correct. And I didn't imply you could. Read my comment of 17-Feb-24 13:11 again.
Stating it again....
The OP said that the ONLY thing requested was adding interfaces. Nothing else.
You responded directly to that, you quoted that line from the OP.
And stated you "follow that guideline at my shop."
You did not qualify that by suggesting that it was part of a larger process that would lead to better code.
Perhaps you meant to encompass the entire development process but that is NOT what you said in your original post.
|
|
|
|
|
It only makes sense to me when it can be more than one "is a". Other than that, it's another "ritual". And all you keep doing is going back and forth between (one) "implementation" and interface; until it's obvious one needs (or can benefit from) an interface.
Then you also have to deal with the school that says "no inheritance"; which in essence means no "base methods"; virtual or otherwise. Another pointless ritual that only becomes "real" because someone "ordered" it; or can't decide when it is appropriate. See: "abstract" TextBoxBase.
"Before entering on an understanding, I have meditated for a long time, and have foreseen what might happen. It is not genius which reveals to me suddenly, secretly, what I have to say or to do in a circumstance unexpected by other people; it is reflection, it is meditation." - Napoleon I
|
|
|
|
|
I do like the rule of no concrete super/base classes. One concrete type extending another concrete type always causes grief down the road when someone adds a third concrete type into the mix.
|
|
|
|
|
englebart wrote: One concrete type extending another concrete type
The problem there however is overuse of inheritance.
The solution is to use composition instead.
|
|
|
|
|
Whoever gave that directive is a man after my own heart.
It's extreme, to be sure. Realistic to literally follow 100% of the time? Probably not. But as an aspiration, a philosophy - absolutely.
If you do this, you will be able to grow and scale your products effortlessly for decades - basically for as long as the programming language you use is supported - without a rewrite.
Nuget packages, even entire application frameworks will come and go, yet your core code will be snug as a bug in a rug, wrapped in layers of abstraction that shield it from the chaos.
When your favorite library is deprecated, revealed to have a critical vulnerability, or the vendor jacks up the price on you, you scoff at how simple it is to assign someone to find a replacement and write the wrapper layer - completely independently of everyone else. Your customer tells you the application you designed for Azure now needs to run on AWS? "No problem", you say, "give me a week." Microsoft decides to make 100 new breaking changes to ASP.NET Core? Bah! The upgrade takes an hour.
You will never be stuck relying on proprietary technology outside of your control ever again. The term "technical debt" won't even be part of your vocabulary.
So yes. Those who know, do this.
|
|
|
|
|
Yep, I think you nailed the truth of it. It is definitely a core practice to follow.
Very few people think of software dev in these terms.
I'm guessing you've built or worked on extremely large projects?
|
|
|
|
|
Peter Moore - Chicago wrote: If you do this, you will be able to grow and scale your products effortlessly for decades - basically for as long as the programming language you use is supported
And have you actually done that?
I have worked on multiple legacy products and never seen anything like that.
At a minimum I can't see it happening in any moderate to large business unless the following was true
- Dedicated high level architect (at least director level) whose job is technical not marketing. The person enforces the design.
- Same architect for a very long time. With perhaps a couple other architects trained solely by that individual.
- Very strict controls on bringing in new idioms/frameworks.
- Very likely extensive business requirements to support multiple different configurations. From the beginning. That would insure the initial design actually supports that.
What I have seen is even in a company started with a known requirement to support multiple different implementations in rapid order (about a year) new hires decided to implement their own generalized interface on top of the original design without accounting for all the known (not hypothetical) variants. Making the addition of the newer variants into a kludge of code to fit on top of what the new hires did.
|
|
|
|
|
jschell wrote: At a minimum I can't see it happening in any moderate to large business unless the following was true
- Dedicated high level architect (at least director level) whose job is technical not marketing. The person enforces the design.
You make a good point. It takes an experienced technical team to lay down guidelines like these.
Over the past 20 years I've worked mostly at early stage companies with very experienced small teams, each of which was tasked with implementing portions of a larger complex product. Because requirements are almost always less known early in a product's evolution, using the technique of enforcing interface definitions allows the code to naturally evolve as the requirements change and become more solidified. Coupled with a strict regimen of writing automated unit and integration tests, defensive programming designs like these increase the chances of developing a complex app with fewer bugs.
/ravi
|
|
|
|
|
|
raddevus wrote: Would you balk? or think, "Yes, that is the way it is and should be."
Depends.
If one complex layer (A) is dependent on another complex layer (B) then unit testing A becomes quite a bit more difficult if B does not provide and interface.
raddevus wrote: Do you know how crazy it is to look at project that has been designed this way?
Designing general solutions based on one implementation will fail. The general solution will encapsulate all of the assumptions about the single implementation. So it achieves nothing in terms of generalization.
Even when multiple implementations are known it requires rigorous oversight to insure that someone doesn't attempt to generalize a subsection of the implementations. They end up doing the same thing - implementing based on just the subsection.
|
|
|
|
|
Another corollary that a comment triggered,
Quote: Create a facade around any API that you are using to protect your code from changes in the API.
|
|
|
|
|
quote Create a facade around any API that you are using to protect your code from changes in the API.
A great idea that no one ever does.
Ok, not no one, but it is done more rarely than it should be.
Also, there are physical limitations to it.
We use a 3rd party component that has 100s methods.
We should wrap the component but it gonna take a while. 
|
|
|
|
|
A 1:1 mapping is not what I was envisioning. (Beginners might miss that joke! What’s the point?)
Facade/Wrapper/Adapter/Proxy/etc
|
|
|
|
|
englebart wrote: Facade/Wrapper/Adapter/Proxy/etc
Yes but then all of those are classes also. And thus those two require an interface...
Myself I am joking but I remember quite a few years ago someone posting somewhere that all the classes in the application were required to have an interface and a factory.
|
|
|
|
|
A facade should be the simplest requirements needed for your code’s clients. If the library I am using has 5 classes and hundreds of methods/properties, my facade could be as simple as one class with 5 properties and 1 method. Since my facade has a hard dependency on the library, I would use an interface so that my consumers do NOT have a compile time dependency on the library.
Like I said earlier, (possibly paraphrased) if you find yourself wrapping everything 1:1, then just accept the hard dependency and ship! ship! The facade might be added later (YAGNI) as well as only if the next major update to the library has breaking changes. Without the facade I would have 70 projects to change. With the facade I have one project to change.
I do agree with the release often philosophy.
A lot of this depends on team size, pace, code stability, etc.
And maybe IDE? Creating an interface from a class or a class from an interface should not take more than a second. Right click…
Someone earlier mentioned they were stuck on VS2013. Yuck!
|
|
|
|
|
Why? How difficult is it to adopt the old semantics of a given dependency, and shim a a new replacement library when it becomes necessary to jump ship. I have done this a few times, though not often. Seems like deferring the pain ('YAGNI') until it becomes necessary is optimal overall.
|
|
|
|
|
hpcoder2 wrote: Seems like deferring the pain ('YAGNI') until it becomes necessary is optimal overall
Yeah, exactly.
You can either have:
1) Pain now (All Interfaces)
2) Pain later (that may never occur)
I figure take the pain later -- cause a lot of software rots for other reasons and is completely re-written anyways. So, you may never reach the "pain later" stage anyways.
As a matter of fact, I've rarely seen it in 35 years of software development.
And, when another manager comes in anyways, they think something totally different and wipe away the "old" code, even if it is extensible from all those Interfaces.
|
|
|
|
|
I program since more than 40 years and develop software since more than 30 years.
15 years ago I heard first time about DI containers, and since 10 years I use IODA as principle to avoid DI containers.
Only integration classes are allowed to call other operations.
If you put the whole logic into operation-classes, with no logic in data-classes and integration-classes (only something like "rail-switches" in integrations),
then separate input- and output- from logical operations,
than you do not need to discuss those things like DI any longer.
I use derivation very rarely, combination of classes is my favorite.
But I use also actions and closures.
You don't have to hide every operation class behind an interface, but it can be helpful.
Consider: By using of interfaces you can not longer jump to the executed code by just pressing "F12" in Developer Studio.
There is no universal answer to this question, it just depends on ...
What is IODA? See here:
https://www.infoq.com/news/2015/05/ioda-architecture/[^]
|
|
|
|
|
Fantastic and interesting reply.
Thanks so much for sharing your experience here.
Interesting that you specifically avoid DI.
Ralf Peine 2023 wrote: By using of interfaces you can not longer jump to the executed code by just pressing "F12" in Developer Studio.
That is definitely one of the problems that I encounter with DI.
It is a pain that the implementation is always somewhere else which you have to track down.
Must say though, that I downloaded VSTudio 2023 to help with this and now it can (as you would hope) navigate to the exact implementation -- even if the code is in another dll it will use reflection to show you the code. Very good.
|
|
|
|
|
Hmmm... once you decide that *all* something must do *something*, before you even know what problem you're about to solve, you've decided that reality takes second place to what you've decided reality should be. "Dijkstra would not like this" <- his immortality, for those who get the reference.
|
|
|
|
|
From CP newsletter
Create AI pro register to uphold ethics, says BCS • The Register[^]
In UK there is a proposal to license/enforce corps when using AI.
Then it uses the problem as an example with the UK government prosecuting post office managers for something that never happened.
Except of course that had nothing to do with AI. And the proposed rules are for corporations. No idea how that is supposed to prevent the government from making false allegations.
Reminds me of the silliness of a case in the US where people were prosecuted due to 'recovered memory' testimony from very young children against a number of people accusing them of satanic rituals. The testimony allowed defied logic.
McMartin preschool trial - Wikipedia[^]
That was far from the only case where recovered memories were allowed.
Unfortunately in the US quite a few people still believe in that nonsense along with so called professionals that keep promoting it.
|
|
|
|
|
So at some point, along with the "harassment training" (which, ironically, is supposed to teach you how to identify and prevent harassment and not be a harasser yourself, rather than training you on how to excel at harassment as the course name would seem to suggest, but I digress) at some point corporations will have an "ethical AI training" class we'll all have to take. Except for management. 
|
|
|
|
General 
News 
Suggestion 
Question 
Bug 
Answer 
Joke 
Praise 
Rant 
Admin 
Submit an article or tip
