Merge pull request #507 from neet/api-integration

chore: Change api root to /rest

packages/@neet/vschedule-api-spec/build.sh

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+rm -rf ./dist
 yarn run tsc
 yarn run mkdirp ./dist
 node ./dist/api.js >./dist/api.json

packages/@neet/vschedule-api-spec/src/api.ts

@@ -27,7 +27,7 @@ for (const module of modules) {
 const document = new OpenAPIGenerator(registry.definitions).generateDocument({
   openapi: '3.0.1',
   info: {
-    title: 'Refined Itsukara.link',
+    title: 'VSchedule Rest API',
     version: JSON.parse(
       fs.readFileSync(path.join(__dirname, '../package.json'), 'utf-8'),
     ).version,
@@ -42,6 +42,10 @@ const document = new OpenAPIGenerator(registry.definitions).generateDocument({
       url: 'http://localhost:3000',
       description: 'Development environment',
     },
+    {
+      url: 'https://api.vschedule.app',
+      description: 'Production',
+    },
   ],
 });
 

packages/@neet/vschedule-api-spec/src/paths/api/v1/media.ts → packages/@neet/vschedule-api-spec/src/paths/rest/v1/media.ts

@@ -4,7 +4,7 @@ import { registry } from '../../../api';
 import { PathMediaFilename } from '../../../components/parameters/PathMediaFilename';
 
 registry.registerPath({
-  path: '/api/v1/media/{mediaFilename}',
+  path: '/rest/v1/media/{mediaFilename}',
   method: 'get',
   operationId: 'showMedia',
   summary: 'メディアを表示',

packages/@neet/vschedule-api-spec/src/paths/api/v1/organizations.ts → packages/@neet/vschedule-api-spec/src/paths/rest/v1/organizations.ts

@@ -6,7 +6,7 @@ import { Organization } from '../../../components/schemas/Organization';
 
 registry.registerPath({
   method: 'get',
-  path: '/api/v1/organizations/{organizationId}',
+  path: '/rest/v1/organizations/{organizationId}',
   operationId: 'showOrganization',
   summary: '組織を表示',
   request: {
@@ -26,7 +26,7 @@ registry.registerPath({
 
 registry.registerPath({
   method: 'get',
-  path: '/api/v1/organizations',
+  path: '/rest/v1/organizations',
   operationId: 'listOrganizations',
   summary: '組織を一覧',
   request: {
@@ -56,7 +56,7 @@ const CreateOrganization = z.object({
 
 registry.registerPath({
   method: 'post',
-  path: '/api/v1/organizations',
+  path: '/rest/v1/organizations',
   operationId: 'createOrganization',
   summary: '組織を作成',
   request: {
@@ -84,7 +84,7 @@ const UpdateOrganization = CreateOrganization.partial();
 
 registry.registerPath({
   method: 'patch',
-  path: '/api/v1/organizations/{organizationId}',
+  path: '/rest/v1/organizations/{organizationId}',
   operationId: 'updateOrganization',
   summary: '組織を作成',
   request: {

packages/@neet/vschedule-api-spec/src/paths/api/v1/performers.ts → packages/@neet/vschedule-api-spec/src/paths/rest/v1/performers.ts

@@ -6,7 +6,7 @@ import { Performer } from '../../../components/schemas/Performer';
 
 registry.registerPath({
   method: 'get',
-  path: '/api/v1/performers/{performerId}',
+  path: '/rest/v1/performers/{performerId}',
   operationId: 'showPerformer',
   summary: 'パフォーマーを表示',
   request: {
@@ -26,7 +26,7 @@ registry.registerPath({
 
 registry.registerPath({
   method: 'get',
-  path: '/api/v1/performers',
+  path: '/rest/v1/performers',
   operationId: 'listPerformers',
   summary: 'パフォーマーを一覧',
   request: {
@@ -67,7 +67,7 @@ const CreatePerformer = z.object({
 
 registry.registerPath({
   method: 'post',
-  path: '/api/v1/performers',
+  path: '/rest/v1/performers',
   operationId: 'createPerformer',
   summary: 'パフォーマーを作成',
   request: {
@@ -105,7 +105,7 @@ const UpdatePerformer = z
 
 registry.registerPath({
   method: 'patch',
-  path: '/api/v1/performers/{performerId}',
+  path: '/rest/v1/performers/{performerId}',
   operationId: 'updatePerformer',
   summary: 'パフォーマーを更新',
   request: {
@@ -134,7 +134,7 @@ registry.registerPath({
 
 registry.registerPath({
   method: 'post',
-  path: '/api/v1/performers/{performerId}/subscribe',
+  path: '/rest/v1/performers/{performerId}/subscribe',
   operationId: 'subscribeToPerformer',
   summary: 'パフォーマーを購読',
   request: {

packages/@neet/vschedule-api-spec/src/paths/api/v1/streams.ts → packages/@neet/vschedule-api-spec/src/paths/rest/v1/streams.ts

@@ -6,7 +6,7 @@ import { Stream } from '../../../components/schemas/Stream';
 
 registry.registerPath({
   method: 'get',
-  path: '/api/v1/streams/{streamId}',
+  path: '/rest/v1/streams/{streamId}',
   operationId: 'showStream',
   summary: '配信を表示',
   request: {
@@ -29,7 +29,7 @@ registry.registerPath({
 
 registry.registerPath({
   method: 'post',
-  path: '/api/v1/streams',
+  path: '/rest/v1/streams',
   operationId: 'createStream',
   summary: '配信を作成',
   request: {
@@ -56,7 +56,7 @@ registry.registerPath({
 
 registry.registerPath({
   method: 'get',
-  path: '/api/v1/streams',
+  path: '/rest/v1/streams',
   operationId: 'listStreams',
   summary: '配信を一覧',
   request: {},

packages/@neet/vschedule-api/prisma/seed.ts

@@ -7,6 +7,7 @@ import {
   NIJISANJI_YOUTUBE_CHANNEL_ID,
   organizations,
 } from '@neet/vschedule-seeds';
+import { PrismaClient } from '@prisma/client';
 
 import { IOrganizationRepository } from '../src/app/repositories/OrganizationRepository';
 import { IPerformerRepository } from '../src/app/repositories/PerformerRepository';
@@ -16,6 +17,7 @@ import { YoutubeChannelId } from '../src/domain/_shared';
 import { container } from '../src/infra/inversify-config';
 import { TYPES } from '../src/types';
 
+const prisma = container.get<PrismaClient>(TYPES.PrismaClient);
 const createOrganization = container.get(CreateOrganization);
 const createPerformer = container.get(CreatePerformer);
 const performerRepository = container.get<IPerformerRepository>(
@@ -105,6 +107,10 @@ const main = async (): Promise<void> => {
   }
 };
 
-main().catch((error) => {
-  throw error;
-});
+main()
+  .catch((error) => {
+    throw error;
+  })
+  .finally(async () => {
+    await prisma.$disconnect();
+  });

packages/@neet/vschedule-api/src/adapters/controllers/api/v1/media.ts → packages/@neet/vschedule-api/src/adapters/controllers/rest/v1/media.ts

@@ -8,7 +8,7 @@ import {
 
 import { ShowMediaAttachment } from '../../../../app/use-cases/ShowMediaAttachment';
 
-@controller('/api/v1/media')
+@controller('/rest/v1/media')
 export class MediaAttachmentController extends BaseHttpController {
   constructor(
     @inject(ShowMediaAttachment)

packages/@neet/vschedule-api/src/adapters/controllers/api/v1/organizations.ts → packages/@neet/vschedule-api/src/adapters/controllers/rest/v1/organizations.ts

@@ -18,7 +18,7 @@ import { ListOrganization } from '../../../../app/use-cases/ListOrganizations';
 import { ShowOrganization } from '../../../../app/use-cases/ShowOrganization';
 import { RestApiPresenter } from '../../../mappers/RestApiMapper';
 
-@controller('/api/v1/organizations')
+@controller('/rest/v1/organizations')
 export class OrganizationsController extends BaseHttpController {
   public constructor(
     @inject(ShowOrganization)

packages/@neet/vschedule-api/src/adapters/controllers/api/v1/performers.ts → packages/@neet/vschedule-api/src/adapters/controllers/rest/v1/performers.ts

@@ -23,7 +23,7 @@ import { SubscribeToPerformer } from '../../../../app/use-cases/SubscribeToYoutu
 import { UpdatePerformer } from '../../../../app/use-cases/UpdatePerformer';
 import { RestApiPresenter } from '../../../mappers/RestApiMapper';
 
-@controller('/api/v1/performers')
+@controller('/rest/v1/performers')
 export class PerformersController extends BaseHttpController {
   constructor(
     @inject(ShowPerformer)

packages/@neet/vschedule-api/src/adapters/controllers/api/v1/streams.ts → packages/@neet/vschedule-api/src/adapters/controllers/rest/v1/streams.ts

@@ -14,7 +14,7 @@ import { ListStreams } from '../../../../app/use-cases/ListStreams';
 import { ShowStream } from '../../../../app/use-cases/ShowStream';
 import { RestApiPresenter } from '../../../mappers/RestApiMapper';
 
-@controller('/api/v1/streams')
+@controller('/rest/v1/streams')
 export class StreamsRestApiController extends BaseHttpController {
   constructor(
     @inject(ListStreams)

packages/@neet/vschedule-api/src/adapters/dal/JobRepository.ts

@@ -8,6 +8,7 @@ import {
   RefreshJob,
 } from '../../app/repositories/JobRepository';
 import { IAppConfig } from '../../app/services/AppConfig/AppConfig';
+import { ILogger } from '../../app/services/Logger';
 import { TYPES } from '../../types';
 
 @injectable()
@@ -18,13 +19,16 @@ export class JobRepository implements IJobRepository {
   public constructor(
     @inject(TYPES.AppConfig)
     config: IAppConfig,
+
+    @inject(TYPES.Logger)
+    private readonly _logger: ILogger,
   ) {
     this._origin = config.entries.server.origin;
   }
 
   async queue(job: RefreshJob): Promise<void> {
     const origin = new URL(this._origin);
-    origin.pathname = `/api/v1/performers/${job.actorId}/subscribe`;
+    origin.pathname = `/rest/v1/performers/${job.actorId}/subscribe`;
     const url = origin.toString();
 
     await this._tasks.createTask({
@@ -38,5 +42,7 @@ export class JobRepository implements IJobRepository {
         }),
       },
     });
+
+    this._logger.info(`Queued invocation of URL ${url}`, { url, job });
   }
 }

packages/@neet/vschedule-api/src/adapters/mappers/RestApiMapper.ts

@@ -28,7 +28,7 @@ export class RestApiPresenter {
   public presentMediaAttachment(
     mediaAttachment: MediaAttachment,
   ): Schemas.MediaAttachment {
-    const pathname = `/api/v1/media/${mediaAttachment.filename.value}`;
+    const pathname = `/rest/v1/media/${mediaAttachment.filename.value}`;
     const url = new URL(this._origin);
     url.pathname = pathname;
 

packages/@neet/vschedule-api/src/infra/app.ts

@@ -1,11 +1,12 @@
-import '../adapters/controllers/api/v1/performers';
-import '../adapters/controllers/api/v1/organizations';
-import '../adapters/controllers/api/v1/media';
-import '../adapters/controllers/api/v1/streams';
+import '../adapters/controllers/rest/v1/performers';
+import '../adapters/controllers/rest/v1/organizations';
+import '../adapters/controllers/rest/v1/media';
+import '../adapters/controllers/rest/v1/streams';
 import '../adapters/controllers/websub/youtube';
 import './setup';
 
 import api from '@neet/vschedule-api-spec';
+import cors from 'cors';
 import express, { Application } from 'express';
 import * as OpenApiValidator from 'express-openapi-validator';
 import expressWinston from 'express-winston';
@@ -36,8 +37,9 @@ export const createApp = (container: Container): Application => {
     app.use(expressWinston.logger({ winstonInstance: logger }));
 
     app.use('/docs', swaggerUi.serve, swaggerUi.setup(api));
+    app.use('/rest', cors());
     app.use(
-      '/api',
+      '/rest',
       OpenApiValidator.middleware({
         apiSpec: require.resolve('@neet/vschedule-api-spec'),
         validateApiSpec: true,