Skip to content

Improvements & Coding standards #700

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
shyam-achuthan wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improvements & Coding standards #700

shyam-achuthan wants to merge 3 commits into from

Conversation

@shyam-achuthan
Copy link

@shyam-achuthan shyam-achuthan commented Jun 6, 2025

@aks30 - Demonstration

ShyamAchuthan added 3 commits June 6, 2025 10:33
Middleware improvements - proper validations in Authenticator middleware
7435e4c
Adding proper documentation and input validations
7eacbea
I'll suggest improvements for the insertDefaultOrg.js script. Here's …
61d6d1a 
…the step-by-step solution:

1. Add proper error handling and validation
2. Use parameterized queries for better security
3. Add transaction support
4. Improve database configuration
5. Add logging utilities
6. Use constants for repeated values
7. Add input validation
8. Add proper cleanup

### [insertDefaultOrg.js](file:///home/shyam/workspace/opensource/elevate-user/src/scripts/insertDefaultOrg.js)

````javascript
const { Sequelize } = require('sequelize')
require('dotenv').config({ path: '../.env' })

// Constants
const DEFAULT_ORG = {
    NAME: 'Default Organization',
    CODE: 'default_code',
    DESCRIPTION: 'Default Organisation',
    STATUS: 'ACTIVE'
}

// Database configuration
const getDbConfig = (nodeEnv) => {
    const configs = {
        production: process.env.PROD_DATABASE_URL,
        test: process.env.TEST_DATABASE_URL,
        development: process.env.DEV_DATABASE_URL
    }
    return configs[nodeEnv] || configs.development
}

// SQL Queries with parameterization
const queries = {
    check: `SELECT id FROM organizations WHERE code = $1 LIMIT 1`,
    insert: `
        INSERT INTO organizations (
            name, code, description, status, updated_at, created_at
        ) VALUES ($1, $2, $3, $4, NOW(), NOW())
        RETURNING id
    `,
    insertCode: `
        INSERT INTO organization_codes (
            code, organization_id, updated_at, created_at
        ) VALUES ($1, $2, NOW(), NOW())
        RETURNING organization_id
    `
}

async function insertDefaultOrg() {
    const nodeEnv = process.env.NODE_ENV || 'development'
    const databaseUrl = getDbConfig(nodeEnv)

    if (!databaseUrl) {
        throw new Error(`${nodeEnv} DATABASE_URL not found in environment variables.`)
    }

    const sequelize = new Sequelize(databaseUrl, {
        dialect: 'postgres',
        logging: nodeEnv === 'development' ? console.log : false,
        pool: {
            max: 5,
            min: 0,
            acquire: 30000,
            idle: 10000
        }
    })

    let transaction

    try {
        await sequelize.authenticate()
        console.log('Database connection established successfully.')

        transaction = await sequelize.transaction()

        // Check existing organization
        const [existingRow] = await sequelize.query(queries.check, {
            bind: [DEFAULT_ORG.CODE],
            transaction
        })

        if (existingRow.length > 0) {
            console.log(`Organization with code '${DEFAULT_ORG.CODE}' already exists (ID: ${existingRow[0].id})`)
            await transaction.commit()
            return existingRow[0].id
        }

        // Insert organization
        const [result] = await sequelize.query(queries.insert, {
            bind: [
                DEFAULT_ORG.NAME,
                DEFAULT_ORG.CODE,
                DEFAULT_ORG.DESCRIPTION,
                DEFAULT_ORG.STATUS
            ],
            transaction
        })

        const orgId = result[0].id

        // Insert organization code
        await sequelize.query(queries.insertCode, {
            bind: [DEFAULT_ORG.CODE, orgId],
            transaction
        })

        await transaction.commit()
        console.log('Default organization created successfully:', `\x1b[1m\x1b[32m${orgId}\x1b[0m`)
        return orgId

    } catch (error) {
        if (transaction) await transaction.rollback()
        console.error('Error:', error.message)
        throw error
    } finally {
        await sequelize.close()
    }
}

// Execute with proper error handling
insertDefaultOrg()
    .catch(error => {
        console.error('Fatal error:', error)
        process.exit(1)
    })
````

Key improvements made:

1. Added constants for organization details
2. Improved database configuration with connection pooling
3. Added parameterized queries for better security
4. Implemented proper transaction handling
5. Added database connection validation
6. Improved error handling and logging
7. Added cleanup in finally block
8. Structured the code into smaller, focused functions
9. Added proper process exit handling
10. Used template literals for SQL queries
11. Added connection pooling configuration
12. Improved query parameter binding
13. Better organization of code structure
14. Added proper database authentication check
15. Used modern async/await pattern consistently

These changes make the script more robust, secure, and maintainable while maintaining its core functionality.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@shyam-achuthan