Code Review | Ann Jessica Tan

Code Review Video

This 30-minute code review provides a detailed analysis of the original artifact, identifies areas for improvement, and outlines the enhancement plan for all three categories of the capstone project.

Note: This video was created as part of Milestone One (Module 2) before implementing any enhancements. It demonstrates my ability to analyze existing code, identify improvement opportunities, and plan comprehensive modifications that address course outcomes.

Watch on YouTube Download Video

Video Content Overview

Part A: Existing Functionality

The review begins with a detailed walkthrough of the original CRUD module from CS-340, covering:

Initial MongoDB connection setup and configuration
Create and Read methods implementation
Input validation and error handling approaches
Code structure and organization
Testing methodology and results

Part B: Code Analysis

Comprehensive analysis of areas for improvement:

Structure & Organization

Identified opportunities for better code organization, modularization, and following PEP 8 standards.

Efficiency & Performance

Analyzed query performance, potential bottlenecks, and opportunities for optimization.

Security Considerations

Highlighted security vulnerabilities including hardcoded credentials and lack of input sanitization.

Documentation & Testing

Evaluated documentation completeness and test coverage, identifying gaps.

Part C: Enhancement Plan

Detailed walkthrough of planned enhancements across three categories:

Software Design & Engineering: Complete CRUD implementation, error handling improvements, configuration management
Algorithms & Data Structures: Caching system, sorting algorithms, search optimization, data analysis features
Databases: Index optimization, aggregation pipelines, schema validation, performance analysis

Course Outcomes Alignment

This code review demonstrates achievement of multiple CS-499 course outcomes:

Collaborative Environments

Demonstrates ability to conduct professional code reviews and communicate technical plans effectively to peers and managers.

Professional Communication

Showcases clear technical communication through structured video presentation, appropriate for both technical and non-technical audiences.

Algorithmic Solutions

Discusses planned algorithmic enhancements and their impact on system performance and efficiency.

Well-founded Techniques

Uses industry-standard code review practices and tools (OBS Studio, structured analysis methodology).

Security Mindset

Identifies security vulnerabilities and plans mitigations, demonstrating proactive security thinking.

Artifact Context

This code review focuses on the original artifact: TAN_CRUD_Python_Module.py from CS-340: Client/Server Development.

Original Artifact Characteristics:

Source: CS-340 Module 4 assignment
Creation Date: October 2025
Original Purpose: Basic MongoDB CRUD operations for animal shelter data
Initial State: 52-line Python module with Create and Read functionality only
Technologies: Python, PyMongo, MongoDB

Transformation Strategy:

The review outlines a progressive enhancement approach where the same artifact would be enhanced across all three required categories, rather than using separate artifacts. This demonstrates cohesive skill development and the ability to incrementally improve a single codebase.