Clean Code [Part-1]

SriSarvesh — Sat, 30 Dec 2023 07:29:06 +0000

Clean code involves enhancing existing code through a process called refactoring. Whether you're writing a full code for a new feature or making changes, it's essential to iterate and refine the code.
A code base can survive for long period if its continuously improved and refactored. Whenever you introduce something new to the code base, the goal is to enhance the existing code in the process.

Clean Code Metrics

Clean code should be readable and meaningful.
Should reduce the time that we take to understand whats happening.
Precision is key, the code should be concise and to the point.
It must steer clear of using unclear names, complex nesting, and overly large code blocks.
Should follow widely accepted best practices, patterns, and principles is crucial.
The code should be enjoyable, easily maintainable, and readily understandable.

Clean Code Focuses On

Names that we give to (variables,functions,classes).
Structure of the code that we have in our project like the no of lines that we leave between each line of code.
Comments that we make in our code.
Splitting Responsibility of a function or a class like what a particular function does and its purpose.
No of parameters that we pass to function.
Avoiding deep nesting of conditional statements and loops.
Error and Exception handling in the code.

Naming Convention

1.snake_case:
In this convention multiple words are separated by underscore.And every character is in lowercase.

Applied in variables,functions and methods name.
Language uses this convention: Python

Ex:

 is_valid = true

 def return_response():
     return True

2.camelCase:
In this casing convention the variables will be having multiple words and the first word’s character starts with lower case,but the next word's first character will be starting with uppercase.

Applied in variables,functions,methods name.
Language uses this convention: Python,Javascript

Ex:

 const isValid = true;

 function returnResponse(){
     return true;
 }

3.PascalCase:
Here in this casing convention the words in the variable starts with the uppercase letter and no space between the words.It is same as camelCase but here the first word's first letter also starts with uppercase.

Applied in class name.
Language uses this convention: Python,Javascript

Ex:

class AdminRole{

}

How to choose name for variables,functions,class?

When we want to store properties like name,age,email etc.We can store it in a variable with name describing whose properties and its what kind of properties it is.

Ex: Here the below variable name hold's the object of customer and their personal details.

 const customerDetails = {
        name:"Gopi",
        age:"2",
        email:"sample@gmail.com"
 }

And when we want to store boolean value for a variable or when a boolean value is being returned by a function the name should represent a question and the value or the function body should be an answer for it.

Ex: Here the below variable store's the boolean value that tells whether an user is available or not.

 let isAvailable = true;

 function  isValidUserInput(){
  The function name should describe what kind of check is being done.
 }

And when we want to name a class,it should represent what kind of object we will create based on the class.

Ex: When we want the object of different users then the class name will be. The class name's specifies what kind of user the object of the class will hold.

 class Admin{

 }

 class Customer{

 }

And even when we want to create a static class that has utility methods the name should represent what kind of utility method's the class will hold.

Ex:The class name below will act as a container for the various pieces of data or functionality.

 class DateUtility{ 
   So this class will hold the the utility methods of date
 }

Some more naming tips:

A variable name that we give should be specific and should tell us what value is being stored.
But also it should not be too specific and very long and describing each and every thing and lists too much information.
And also we should avoid unclear abbreviations like ymdt = “20220121CET”,instead we can name it like

const dateWithTimeZone =  “20220121CET”;

Be consistent in the convention that we choose and use it fully throughout the whole code base.
So in the situation where there are variable's like getUsers(),fetchUsers(),retrieveUsers() we should use any one of the convention out of it.
And when we choose a convention for fetching users like
fetchUsers() then for other entities also we should do it like that fetchProducts().

Redis

SriSarvesh — Thu, 24 Nov 2022 04:30:44 +0000

The open-source, in-memory data store is used by millions of developers as a database, cache, streaming engine, and message broker(It can be used as a queue manager for our jobs).
But if the data that we are trying to store is bigger than memory then we need to move it to the secondary storage and then execute which makes it useless of the Redis concept.
So it is better to have data in the Redis smaller than the memory. So that we can perform all kinds of computations easily.
And also this Redis should be treated like NoSQL. And this follows a client-server architecture and we try to connect to the server(which runs as a process at port 6379(localhost) ) to perform the required things we wanna perform.
And Redis comes with cli(client) using which we can perform the required operations on the server. And also there is a UI-based client which is a Redis Desktop Manager.
Using

sudo snap install redis-desktop-manager

We install the GUI-based Redis-desktop-manager.

So after installing the GUI-based app we can connect to the local connection by giving a sample name. And then we will be able to see various databases and they are index based instead of names.
And by clicking each of those db(index) we can insert multiple key-value pairs. And for each key, there will be a value and we can set up TTL(Time to live in seconds) which means the duration for how long this key-Value will be stored in the Redis DB. ( for ex: -1 (then it will be stored for ever). And after the time is over the key value will be removed.
So we have this feature because we want to cache the data only for a certain period of time. So this can be used when we want to cache the result of an External API for a certain period of time and then later we try to remove it from the cache and again perform the API call.
And also there is a concept of Publisher and subscriber concept in Redis. So where there will be a publisher and many subscribers to it and when the publisher publishes certain things then all the subscribers get the
message/content/alerting/push messages to the people.
And also Redis provides the transaction even though we use it as a NoSQL database. And also it provides ACL(Access control list). And also a certain user can establish a connection to this database if they have a valid username and password.
So we use Redis as a JOB queue for handling Asynchronous JOB where the Redis will be used as Publication and Subscriber server for sending push messages to the client (one by one)after the client has made a request to the server. And also we are going to use it as a cache.