Merge pull request #33 from oracle/issue_24_merge_improvements

Issue 24 merge improvements - 1

Author: dbtools-antcampo

.gitignore

@@ -14,4 +14,5 @@ oclif.manifest.json
 **/wallet
 /generated/*
 !/generated/.gitkeep*
-/templates/**/*/package-lock.json
+/templates/**/*/package-lock.json
+/templates/node-angular/.angular/*

doc/DATABASE_CONFIG.md

@@ -0,0 +1,36 @@
+## How to Change Database Configuration
+
+Your database configurations are stored in the `.env` file at the root of your project.
+
+1. **Open the `.env` file.**
+2. **Modify the values** for `DB_USER`, `DB_PASSWORD`, and `CONNECT_STRING` with your new database credentials and connection string.
+    ```plaintext
+    DB_USER=admin
+    DB_PASSWORD=new_password
+    CONNECT_STRING=your_new_connection_string
+    ```
+3. **For Cloud Wallet users**, if you have new wallet credentials, update `WALLET_PASSWORD` and `WALLET_LOCATION` accordingly.
+    ```plaintext
+    WALLET_PASSWORD=new_wallet_password
+    WALLET_LOCATION=./server/utils/db/new_wallet_directory
+    ```
+4. **Optional**: Update `HTTPS_PROXY` and `HTTPS_PROXY_PORT` if your application uses a proxy for database connections.
+
+### Updating Wallet Database Connection
+
+To change your wallet database connection:
+
+1. Go to `server/utils/db`.
+2. Delete the folder named `wallet`.
+3. Decompress your new wallet there and rename it to `wallet`.
+4. Change the password of the database user to your password.
+5. In `server/utils/db/wallet/tnsnames.ora` file, the first paragraph will contain the information to create your `CONNECT_STRING`:
+    ```plaintext
+    tcps://<host>:<port>/<service_name>
+    ```
+
+### Apply Changes
+
+For the changes to take effect, you need to restart your application.
+```bash
+npm run dev

doc/development/TEMPLATES.md

@@ -0,0 +1,102 @@
+# How to Create Templates
+
+Here’s a brief overview of creating and setting up templates for your application projects:
+
+**Starting Point:** The main file is located at `src/index.ts`. The starting point of the code is within the child class `Generate`, which inherits from `Command`. This class utilizes the [oclif](https://oclif.io/docs/commands) dependency, which requires a specific structure in the file.
+
+## Setting Up Your Template
+
+**User Interactions:** Through prompts powered by [inquirer](https://www.npmjs.com/package/inquirer), you will define your application's name, select a project template, and specify database connection preferences, these configurations will be saved in 
+ `configObject`  and sent to `generateDatabaseApp(configObject)` to kickstart the application creation process.
+
+```typescript
+// Ask the user to choose the template.
+const templateChoice = template === '' ? await select(
+    {
+        message: 'Which template would you like to use for your project?',
+        choices: [
+            // Template choices...
+        ],
+        default: 'node-vanilla'
+    },
+) : template;
+```
+
+The `templateChoice` constant allows the user to select a template. You can add your template choices here.
+
+
+```typescript
+// Ask the user for the database connection type.
+const databaseConnectionType = await select(
+    {
+        message: 'Which database connection type would you like to choose?',
+        choices: [
+            // Database connection options...
+        ],
+        default: 'walletPath'
+    }
+);
+```
+
+The `databaseConnectionType` variable prompts the user to choose a database connection type. You can add your connection types here.
+
+```typescript
+// This represents the config object that will hold all the user-inputted information.
+let configObject;
+
+if (databaseConnectionType === 'basic') {
+    // Prompt for protocol, hostname, port, and service details...
+
+    // Configure for basic connection type.
+    configObject = {
+        appName,
+        templateChoice: path.resolve(__dirname, '..', '..', 'templates', templateChoice),
+        connectionString: generateConnectionString(protocol, hostname, port, serviceValue)
+    };
+} else {
+    // Prompt for cloud wallet path and password...
+
+    // Configure for wallet connection type.
+    configObject = {
+        appName,
+        templateChoice: path.resolve(__dirname, '..', '..', 'templates', templateChoice),
+        walletPath,
+        walletPassword,
+    };
+}
+```
+
+## Generate Your Template
+
+The second main file is located at `generators/index.ts` The starting point of the code is within the anonymous class, which inherits from `Generator`. This class utilizes the [Yeoman](https://yeoman.io/authoring/) dependency, which requires a specific structure in the file.
+
+When creating templates, it is important to adhere to the following directory convention:
+
+- Your template should reside within a folder named `templates`.
+- The specific template directory should have the name that corresponds to the value stored in `templateChoice`.
+- Inside your folder template you must have a file named `.gitignore.template` that will genarate a `.gitignore` file in your template
+
+Ensure your template includes a `package.json` file with all necessary dependencies. When project generation, `npm install` will be run automatically to install these dependencies.
+
+### Copied Files
+
+- The `.env.example` is a template for creating a .env file. Copy it, replace placeholders with actual values.
+
+- The `.env` is used to to configure the connection to the database and other services
+
+- The `utils/db/config.cjs` loads environment variables from a `.env` file and saves the database configuration in a constant
+
+- The `utils/db/index.cjs` sets up a database connection pool using OracleDB with configurations from `utils/db/config.cjs`
+
+- The `utils/rest-serv/connection.cjs` exports a function that verifies database connectivity with the database configuration from `utils/db/index.cjs`
+
+- The `routes/connection.cjs` sets up an Express router to serve an endpoint that reports the database connection status using the function from `utils/rest-serv/connection.cjs`.
+
+- The `index.cjs` serves API requests and static files, with logging and CORS support, on port 3000.
+
+
+## Adding New Files 
+
+- Use the `this.fs.copy()` method for straightforward file copying from your template directory to the destination project.
+
+- Use the `this.fs.copyTpl()` for files needing customization or dynamic content based on user input.

src/index.ts

@@ -236,6 +236,11 @@ export default class Generate extends Command {
                         value: 'node-jet',
                         description: 'This creates an empty project with Oracle JET and Oracle database connection starter code.',
                     },
+                    {
+                        name: 'node-angular',
+                        value: 'node-angular',
+                        description: 'This creates an empty project with Angular and Oracle database connection starter code.',
+                    },
                     {
                         name: 'node-react-todo',
                         value: 'node-react-todo',

templates/app/utils/db/index.cjs

@@ -4,6 +4,8 @@
 ** All rights reserved
 ** Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 */
+
+// app/server/utils/db/config.cjs
 const oracledb = require('oracledb');
 const dbConfig = require('./config.cjs');
 
@@ -12,19 +14,37 @@ oracledb.autoCommit = true;
 
 class DBConnector {
     constructor() {
-        this.pool = oracledb.createPool({
-            ...dbConfig,
-            poolMax: 10,
-            poolMin: 10
-        });
+        this.pool = null;
+    }
+
+    async createPool() {
+        if (!this.pool) {
+            try {
+                this.pool = await oracledb.createPool({
+                    ...dbConfig,
+                    poolMax: 10,
+                    poolMin: 10
+                });
+                console.log('Connection pool created successfully.');
+            } catch (error) {
+                console.error('Error creating connection pool:', error);
+                throw error;
+            }
+        }
     }
 
-    getConnection(options = {}) {
-        const pool = oracledb.getPool();
-        return pool.getConnection({
-            ...dbConfig,
-            ...options
-        });
+    async getConnection(options = {}) {
+        await this.createPool();
+        try {
+            const connection = await this.pool.getConnection({
+                ...dbConfig,
+                ...options
+            });
+            return connection;
+        } catch (error) {
+            console.error('Error getting connection:', error);
+            throw error;
+        }
     }
 }
 

templates/app/utils/rest-services/connection.cjs

@@ -4,14 +4,15 @@
 ** All rights reserved
 ** Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 */
-const db = require( '../db/index.cjs' );
+
+const db = require('../db/index.cjs');
 
 exports.getStatus = async function () {
     const connection = await db.getConnection();
-    const result = await connection.execute( 'select 1 from dual' );
+    const result = await connection.execute('select 1 from dual');
     await connection.close();
 
     return {
         status: 'ok',
-    }
+    };
 };

templates/node-angular/.eslintrc.cjs

@@ -0,0 +1,57 @@
+/* eslint-env node */
+
+module.exports = {
+    root: true,
+    env: { 
+        browser: true,
+        es2020: true
+    },
+    extends: [
+        'eslint:recommended',
+    ],
+    rules: {
+        'semi': [
+            'warn',
+            'always'
+        ],
+        'quotes': [
+            'warn',
+            'single'
+        ],
+        'array-bracket-spacing': [
+            'warn',
+            'always',
+            {
+                singleValue: true,
+                objectsInArrays: true,
+                arraysInArrays: true
+            }
+        ],
+        'space-in-parens': [
+            'warn',
+            'always'
+        ],
+        'computed-property-spacing': [
+            'warn',
+            'always'
+        ],
+        'object-curly-spacing': [
+            'warn',
+            'always'
+        ],
+
+        'no-console': [
+            'error',
+            {
+                allow: [
+                    'error',
+                    'warn',
+                ]
+            }
+        ],
+    },
+    ignorePatterns: [
+        'dist/**/*',
+        'node_modules/**/*',
+    ]
+};

templates/node-angular/.gitignore.template

@@ -0,0 +1,60 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# Compiled output
+/dist
+/tmp
+/out-tsc
+/bazel-out
+/dist-ssr
+
+# Node
+/node_modules
+npm-debug.log
+yarn-error.log
+yarn-debug.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+# IDEs and editors
+.idea/
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+*.local
+
+# Visual Studio Code
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# Miscellaneous
+/.angular/cache
+.sass-cache/
+/connect.lock
+/coverage
+/libpeerconnection.log
+testem.log
+/typings
+/server/utils/db/wallet
+
+# System files
+.DS_Store
+Thumbs.db
+
+# Logs
+logs
+*.log
+
+# Environment variables
+/.env
+/.env.*
+!/.env.example
+!/.env.*.example
+
+# Editor directories and files
+.history/*

templates/node-angular/README.md

@@ -0,0 +1,29 @@
+> NOTE: The applications generated by this package should not be deployed using privileged database accounts. In turn, Oracle recommends for them to be deployed using the least privileged account possible.
+
+# NodeAngular
+
+This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.3.0.
+
+## Development server
+
+Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
+
+## Code scaffolding
+
+Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+
+## Build
+
+Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
+
+## Running unit tests
+
+Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
+
+## Running end-to-end tests
+
+Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
+
+## Further help
+
+To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.