feat: adds functional typescript api clone on NestJS

anthonydmays · anthonydmays · commit fd15a1a9599d · 2024-11-22T09:21:18.000Z
diff --git a/lesson_26/README.md b/lesson_26/README.md
@@ -36,7 +36,7 @@ We are continuing to build atop the foundation of our library app. For this assi
 
 #### Running the API
 
-You can run the server using the usual `./gradlew run` command. If you want to test that the server is running correctly, you can use `curl` like so:
+You can run the server using the usual `./gradlew run` command from the `api/java` directory. If you want to test that the server is running correctly, you can use `curl` like so:
 
 ```bash
 curl http://localhost:5000/items | json_pp
@@ -46,4 +46,8 @@ Alternatively, you can test the API using the tool [Postman][postman-link]. I re
 
 ## Additional resources
 
-* [gRPC vs REST: Comparing API Styles in Practice (Article)](https://dev.to/anthonydmays/grpc-vs-rest-comparing-api-styles-in-practice-4bl): This article explains why the stuff most people call REST isn't actually.
+* [gRPC vs REST: Comparing API Styles in Practice (Article)](https://dev.to/anthonydmays/grpc-vs-rest-comparing-api-styles-in-practice-4bl): This article explains why the stuff most people call REST isn't actually.
+
+[controller-file]: ./api/java/api_app/src/main/java/com/codedifferently/lesson26/web/MediaItemsController.java
+[controller-test-file]: ./api/java/api_app/src/test/java/com/codedifferently/lesson26/web/MediaItemsControllerTest.java
+[postman-link]: https://www.postman.com/downloads/
diff --git a/lesson_26/api/java/settings.gradle.kts b/lesson_26/api/java/settings.gradle.kts
@@ -7,7 +7,7 @@
  * in the user manual at https://docs.gradle.org/8.0.2/userguide/multi_project_builds.html
  */
 
-includeBuild("../../lib/java/codedifferently-instructional")
+includeBuild("../../../lib/java/codedifferently-instructional")
 
 rootProject.name = "lesson_26"
 include("api_app")
diff --git a/lesson_26/api/javascript/api_app/src/app.module.ts b/lesson_26/api/javascript/api_app/src/app.module.ts
@@ -1,9 +1,10 @@
 import { Module } from '@nestjs/common';
 import { AppController } from './app.controller';
 import { AppService } from './app.service';
+import { WebModule } from './web/web.module';
 
 @Module({
-  imports: [],
+  imports: [WebModule],
   controllers: [AppController],
   providers: [AppService],
 })
diff --git a/lesson_26/api/javascript/api_app/src/data/data.module.ts b/lesson_26/api/javascript/api_app/src/data/data.module.ts
@@ -1,7 +1,12 @@
 import { Module } from '@nestjs/common';
+import { LIBRARY_DATA_LOADER_PROVIDER } from './library_data_loader';
 import { LibraryJsonDataLoader } from './library_json_data_loader';
 
 @Module({
-    providers: [LibraryJsonDataLoader],
+    providers: [{
+        provide: LIBRARY_DATA_LOADER_PROVIDER,
+        useClass: LibraryJsonDataLoader
+    }],
+    exports: [LIBRARY_DATA_LOADER_PROVIDER]
 })
 export class DataModule {}
diff --git a/lesson_26/api/javascript/api_app/src/data/index.ts b/lesson_26/api/javascript/api_app/src/data/index.ts
@@ -1,2 +1,3 @@
 export { DataModule } from './data.module';
-export { LibraryDataLoader } from './library_data_loader';
+export { LIBRARY_DATA_LOADER_PROVIDER, LibraryDataLoader } from './library_data_loader';
+
diff --git a/lesson_26/api/javascript/api_app/src/data/library_data_loader.ts b/lesson_26/api/javascript/api_app/src/data/library_data_loader.ts
@@ -1,6 +1,6 @@
 import { LibraryDataModel } from '../models/library_data_model';
 
-export const LibraryDataLoaderSymbol = Symbol('LibraryDataLoader');
+export const LIBRARY_DATA_LOADER_PROVIDER = Symbol('LibraryDataLoader');
 
 /** An object that loads data from a source and returns a LibraryDataModel object. */
 export interface LibraryDataLoader {
diff --git a/lesson_26/api/javascript/api_app/src/data/library_json_data_loader.ts b/lesson_26/api/javascript/api_app/src/data/library_json_data_loader.ts
@@ -1,6 +1,6 @@
 import { Injectable } from "@nestjs/common";
-import { LibraryDataModel } from "src/models/library_data_model";
-import LibraryJsonData from '../../resources/data.json';
+import * as LibraryJsonData from '../../resources/data.json';
+import { LibraryDataModel } from "../models/library_data_model";
 import { LibraryDataLoader } from "./library_data_loader";
 
 @Injectable()
diff --git a/lesson_26/api/javascript/api_app/src/library/book.ts b/lesson_26/api/javascript/api_app/src/library/book.ts
@@ -29,6 +29,18 @@ export class Book extends MediaItemBase {
         return this.numberOfPages;
     }
 
+    protected matchesAuthor(authorQuery: string): boolean {
+        if (!authorQuery) {
+            return true;
+        }
+        for (const author of this.getAuthors()) {
+            if (author.toLowerCase().includes(authorQuery.toLowerCase())) {
+                return true;
+            }
+        }
+        return false;
+    }
+
     toString(): string {
         return `Book{id='${this.getId()}', title='${this.getTitle()}'}`;
     }
diff --git a/lesson_26/api/javascript/api_app/src/library/library.module.ts b/lesson_26/api/javascript/api_app/src/library/library.module.ts
@@ -1,5 +1,5 @@
 import { Module } from '@nestjs/common';
-import { LibraryDataLoader, LibraryDataLoaderSymbol } from '../data/library_data_loader';
+import { DataModule, LIBRARY_DATA_LOADER_PROVIDER, LibraryDataLoader } from '../data';
 import { LibraryService } from './library.service';
 import { LibraryFactory } from './library_factory';
 
@@ -8,10 +8,12 @@ const libraryServiceProvider = {
     useFactory: (loader: LibraryDataLoader) => {
         return LibraryFactory.createWithLoader(loader);
     },
-    inject: [LibraryDataLoaderSymbol],
+    inject: [LIBRARY_DATA_LOADER_PROVIDER],
 };
 
 @Module({
+    imports: [DataModule],
     providers: [libraryServiceProvider],
+    exports: [LibraryService]
 })
 export class LibraryModule {}
diff --git a/lesson_26/api/javascript/api_app/src/library/library.service.ts b/lesson_26/api/javascript/api_app/src/library/library.service.ts
@@ -1,16 +1,23 @@
+import { Injectable, Logger } from '@nestjs/common';
 import { Librarian } from './librarian';
 import { LibraryGuest } from './library_guest';
 import { MediaItem } from './media_item';
+import { CatalogSearcher } from './search/catalog_searcher';
+import { SearchCriteria } from './search/search_criteria';
 
+@Injectable()
 export class LibraryService {
-    private itemsById: Map<string, MediaItem> = new Map();
-    private checkedOutItemIds: Set<string> = new Set();
-    private checkedOutItemsByGuest: Map<string, Set<MediaItem>> = new Map();
-    private guestsById: Map<string, LibraryGuest> = new Map();
-    private id: string;
+    private readonly itemsById: Map<string, MediaItem> = new Map();
+    private readonly checkedOutItemIds: Set<string> = new Set();
+    private readonly checkedOutItemsByGuest: Map<string, Set<MediaItem>> = new Map();
+    private readonly guestsById: Map<string, LibraryGuest> = new Map();
+    private readonly id: string;
+    private readonly searcher: CatalogSearcher<MediaItem>;
+    private readonly logger: Logger = new Logger(LibraryService.name);
 
     constructor(id: string) {
         this.id = id;
+        this.searcher = new CatalogSearcher(this.itemsById.values());
     }
 
     getId(): string {
@@ -123,6 +130,16 @@ export class LibraryService {
         return this.checkedOutItemsByGuest.get(guest.getId()) || new Set();
     }
 
+    /**
+     * Search the library for items matching the given query.
+     *
+     * @param query The query to search for.
+     * @return The items matching the query.
+     */
+    search(query: SearchCriteria): ReadonlySet<MediaItem> {
+        return new Set(this.searcher.search(query));
+    }
+
     toString(): string {
         return `Library{itemsById=${Array.from(this.itemsById.entries())}, checkedOutItemIds=${Array.from(
             this.checkedOutItemIds
diff --git a/lesson_26/api/javascript/api_app/src/library/library_guest_base.ts b/lesson_26/api/javascript/api_app/src/library/library_guest_base.ts
@@ -1,11 +1,11 @@
-import crypto from 'crypto';
+import { randomUUID } from 'crypto';
 import { Library } from './library';
 import { LibraryGuest } from './library_guest';
 import { MediaItem } from './media_item';
 
 export class LibraryGuestBase implements LibraryGuest {
     private library: Library | null = null;
-    private readonly id: string = crypto.randomUUID();
+    private readonly id: string = randomUUID();
     private readonly name: string;
     private readonly email: string;
 
diff --git a/lesson_26/api/javascript/api_app/src/library/media_item.ts b/lesson_26/api/javascript/api_app/src/library/media_item.ts
@@ -1,8 +1,9 @@
 import { Library } from './library';
 import { MediaType } from './media_type';
+import { Searchable } from './search/searchable';
 
 /** Represents a media item. */
-export interface MediaItem {
+export interface MediaItem extends Searchable {
     /**
      * Get the type of the media item.
      *
diff --git a/lesson_26/api/javascript/api_app/src/library/media_item_base.ts b/lesson_26/api/javascript/api_app/src/library/media_item_base.ts
@@ -1,6 +1,7 @@
 import { Library } from './library';
 import { MediaItem } from './media_item';
 import { MediaType } from './media_type';
+import { SearchCriteria } from './search/search_criteria';
 
 export abstract class MediaItemBase implements MediaItem {
     private library: Library | null = null;
@@ -44,6 +45,19 @@ export abstract class MediaItemBase implements MediaItem {
         return false;
     }
 
+    matches(query: SearchCriteria): boolean {
+        if (query.id && this.getId() !== query.id) {
+            return false;
+        }
+        if (query.title && !this.getTitle().toLowerCase().includes(query.title.toLowerCase())) {
+            return false;
+        }
+        if (query.type && !this.getType().includes(query.type.toLowerCase())) {
+            return false;
+        }
+        return !query.author || this.matchesAuthor(query.author);
+    }
+
     toString(): string {
         return `MediaItem{id='${this.getId()}', title='${this.getTitle()}'}`;
     }
diff --git a/lesson_26/api/javascript/api_app/src/library/search/catalog_searcher.ts b/lesson_26/api/javascript/api_app/src/library/search/catalog_searcher.ts
@@ -0,0 +1,14 @@
+import { SearchCriteria } from "./search_criteria";
+import { Searchable } from "./searchable";
+
+export class CatalogSearcher<T extends Searchable> {
+    private catalog: Iterable<T>;
+
+    constructor(catalog: Iterable<T>) {
+        this.catalog = catalog;
+    }
+
+    search(query: SearchCriteria): T[] {
+        return [...this.catalog].filter(item => item.matches(query));
+    }
+}
diff --git a/lesson_26/api/javascript/api_app/src/library/search/index.ts b/lesson_26/api/javascript/api_app/src/library/search/index.ts
@@ -0,0 +1,2 @@
+export { SearchCriteria } from "./search_criteria";
+export { Searchable } from "./searchable";
diff --git a/lesson_26/api/javascript/api_app/src/library/search/search_criteria.ts b/lesson_26/api/javascript/api_app/src/library/search/search_criteria.ts
@@ -0,0 +1,13 @@
+export interface SearchCriteria {
+    /** The ID to search for (exact match). */
+    id?: string;
+
+    /** The title to search for. */
+    title?: string;
+
+    /** The author to search for. */
+    author?: string;
+
+    /** The type to search for (exact match). */
+    type?: string;
+}
diff --git a/lesson_26/api/javascript/api_app/src/library/search/searchable.ts b/lesson_26/api/javascript/api_app/src/library/search/searchable.ts
@@ -0,0 +1,11 @@
+import { SearchCriteria } from "./search_criteria";
+
+export interface Searchable {
+    /**
+     * Indicates whether an item matches the search criteria.
+     *
+     * @param query The query to search for.
+     * @return The items that match the query.
+     */
+    matches(query: SearchCriteria): boolean;
+}
diff --git a/lesson_26/api/javascript/api_app/src/main.ts b/lesson_26/api/javascript/api_app/src/main.ts
@@ -1,8 +1,12 @@
 import { NestFactory } from '@nestjs/core';
+import { NestExpressApplication } from '@nestjs/platform-express';
 import { AppModule } from './app.module';
 
 async function bootstrap() {
-  const app = await NestFactory.create(AppModule);
-  await app.listen(process.env.PORT ?? 3000);
+  const app = await NestFactory.create<NestExpressApplication>(AppModule);
+  app.enableCors();
+  app.set('trust proxy', 'loopback'); // Trust requests from the loopback address
+  await app.listen(3000);
 }
-bootstrap();
+
+bootstrap();
diff --git a/lesson_26/api/javascript/api_app/src/web/create_media_item_request.ts b/lesson_26/api/javascript/api_app/src/web/create_media_item_request.ts
@@ -0,0 +1,5 @@
+import { MediaItemRequest } from "./media_item_request";
+
+export interface CreateMediaItemRequest {
+    item: MediaItemRequest;
+}
diff --git a/lesson_26/api/javascript/api_app/src/web/create_media_item_response.ts b/lesson_26/api/javascript/api_app/src/web/create_media_item_response.ts
@@ -0,0 +1,6 @@
+import { MediaItemResponse } from "./media_item_response";
+
+export interface CreateMediaItemResponse {
+  item?: MediaItemResponse;
+  errors?: string[];
+}
diff --git a/lesson_26/api/javascript/api_app/src/web/get_media_items_response.ts b/lesson_26/api/javascript/api_app/src/web/get_media_items_response.ts
@@ -0,0 +1,5 @@
+import { MediaItemResponse } from "./media_item_response";
+
+export interface GetMediaItemsResponse {
+    items: MediaItemResponse[];
+}
diff --git a/lesson_26/api/javascript/api_app/src/web/media_item_request.ts b/lesson_26/api/javascript/api_app/src/web/media_item_request.ts
@@ -0,0 +1,29 @@
+import { randomUUID } from "crypto";
+import { Book, Dvd, Magazine, MediaItem, MediaType, Newspaper } from "../library";
+
+export interface MediaItemRequest {
+    id?: string;
+    type: string;
+    isbn?: string;
+    title: string;
+    authors?: string[];
+    edition?: string;
+    pages?: number;
+    runtime?: number;
+}
+
+export function asMediaItem(request: MediaItemRequest): MediaItem {
+    const id = request.id ? request.id : randomUUID();
+    switch (request.type.toLowerCase()) {
+        case MediaType.BOOK:
+            return new Book(id, request.title, request.isbn, request.authors, request.pages);
+        case MediaType.DVD:
+            return new Dvd(id, request.title);
+        case MediaType.MAGAZINE:
+            return new Magazine(id, request.title);
+        case MediaType.NEWSPAPER:
+            return new Newspaper(id, request.title);
+        default:
+            throw new Error(`Unknown media item type: ${request.type}`);
+    }
+}
diff --git a/lesson_26/api/javascript/api_app/src/web/media_item_response.ts b/lesson_26/api/javascript/api_app/src/web/media_item_response.ts
@@ -0,0 +1,32 @@
+import { Book, MediaItem, MediaType } from '../library';
+
+interface MediaItemResponse {
+    type: MediaType;
+    id: string;
+    isbn?: string;
+    title: string;
+    authors?: string[];
+    edition?: string;
+    pages?: number;
+    runtime?: number;
+}
+
+function toMediaItemResponse(item: MediaItem): MediaItemResponse {
+    const result: MediaItemResponse = {
+        id: item.getId(),
+        title: item.getTitle(),
+        type: item.getType(),
+    };
+
+    if (item.getType() === MediaType.BOOK) {
+        const book = item as Book;
+        result.isbn = book.getIsbn();
+        result.authors = book.getAuthors();
+        result.pages = book.getNumberOfPages();
+    }
+
+    return result;
+}
+
+export { MediaItemResponse, toMediaItemResponse };
+
diff --git a/lesson_26/api/javascript/api_app/src/web/media_items.controller.ts b/lesson_26/api/javascript/api_app/src/web/media_items.controller.ts
diff --git a/lesson_26/api/javascript/api_app/src/web/web.module.ts b/lesson_26/api/javascript/api_app/src/web/web.module.ts
diff --git a/lesson_26/api/javascript/api_app/test/web/media_items.e2e-spec.ts b/lesson_26/api/javascript/api_app/test/web/media_items.e2e-spec.ts
