Merge branch 'main' into unit-testing

Author: Bentroen

.github/workflows/lint.yml

@@ -0,0 +1,32 @@
+name: Lint Code
+
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+    branches:
+      - develop
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+          cache: 'pnpm'
+
+      - name: Install pnpm
+        run: npm install -g pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Run linter
+        run: pnpm lint

pnpm-lock.yaml

@@ -1,4 +1,10 @@
-import { Controller, Get, Param, Query } from '@nestjs/common';
+import {
+  BadRequestException,
+  Controller,
+  Get,
+  Param,
+  Query,
+} from '@nestjs/common';
 import { ApiOperation, ApiTags } from '@nestjs/swagger';
 import { PageQueryDTO } from '@shared/validation/common/dto/PageQuery.dto';
 import { FeaturedSongsDto } from '@shared/validation/song/dto/FeaturedSongsDto.dtc';
@@ -42,4 +48,19 @@ export class SongBrowserController {
   ): Promise<SongPreviewDto[]> {
     return await this.songBrowserService.getSongsByCategory(id, query);
   }
+
+  @Get('/random')
+  @ApiOperation({ summary: 'Get a list of songs at random' })
+  public async getRandomSongs(
+    @Query('count') count: string,
+    @Query('category') category: string,
+  ): Promise<SongPreviewDto[]> {
+    const countInt = parseInt(count);
+
+    if (isNaN(countInt) || countInt < 1 || countInt > 10) {
+      throw new BadRequestException('Invalid query parameters');
+    }
+
+    return await this.songBrowserService.getRandomSongs(countInt, category);
+  }
 }

server/src/song-browser/song-browser.controller.ts

@@ -115,4 +115,11 @@ export class SongBrowserService {
       query.limit ?? 10,
     );
   }
+
+  public async getRandomSongs(
+    count: number,
+    category: string,
+  ): Promise<SongPreviewDto[]> {
+    return await this.songService.getRandomSongs(count, category);
+  }
 }

server/src/song-browser/song-browser.service.ts

@@ -436,6 +436,33 @@ export class SongService {
     return songs.map((song) => SongPreviewDto.fromSongDocumentWithUser(song));
   }
 
+  public async getRandomSongs(
+    count: number,
+    category: string,
+  ): Promise<SongPreviewDto[]> {
+    const songs = (await this.songModel
+      .aggregate([
+        {
+          $match: {
+            visibility: 'public',
+          },
+        },
+        {
+          $sample: {
+            size: count,
+          },
+        },
+      ])
+      .exec()) as unknown as SongWithUser[];
+
+    await this.songModel.populate(songs, {
+      path: 'uploader',
+      select: 'username profileImage -_id',
+    });
+
+    return songs.map((song) => SongPreviewDto.fromSongDocumentWithUser(song));
+  }
+
   public async getAllSongs() {
     return this.songModel.find({});
   }

server/src/song/song.service.ts

@@ -33,7 +33,9 @@ export class SongObfuscator {
   private copyMetaAndStats(song: Song, output: Song) {
     output.meta.name = song.meta.name;
     output.meta.author = song.meta.author;
+    output.meta.originalAuthor = song.meta.originalAuthor;
     output.meta.description = song.meta.description;
+    output.meta.importName = song.meta.importName;
 
     output.loop.enabled = song.loop.enabled;
     output.loop.startTick = song.loop.startTick;

shared/features/song/obfuscate.ts

@@ -44,7 +44,7 @@ export const UploadConst = deepFreeze({
   },
 
   license: {
-    default: 'cc_by',
+    default: 'none',
   },
 
   customInstruments: {
@@ -89,17 +89,21 @@ export const UploadConst = deepFreeze({
   },
 
   licenses: {
-    cc_by_sa: {
-      name: 'Creative Commons - Attribution-ShareAlike 4.0',
-      shortName: 'CC BY-SA 4.0',
-      description:
-        'You can copy, modify, and distribute this song, even for commercial purposes, as long as you credit the author and provide a link to the song. If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.\n\nFor more information, please visit the [Creative Commons website](https://creativecommons.org/licenses/by-sa/4.0/).',
-    },
     standard: {
       name: 'Standard License',
       shortName: 'Standard License',
       description:
         "The author reserves all rights. You may not use this song without the author's permission.",
+      uploadDescription:
+        'You allow us to distribute your song on Note Block World. Other users can listen to it, but they cannot use the song without your permission.',
+    },
+    cc_by_sa: {
+      name: 'Creative Commons - Attribution-ShareAlike 4.0',
+      shortName: 'CC BY-SA 4.0',
+      description:
+        'You can copy, modify, and distribute this song, even for commercial purposes, as long as you credit the author and provide a link to the song. If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.\n\nFor more information, please visit the [Creative Commons website](https://creativecommons.org/licenses/by-sa/4.0/).',
+      uploadDescription:
+        'Anyone can copy, modify, remix, adapt and distribute this song, even for commercial purposes, as long as attribution is provided and the modifications are distributed under the same license.\nFor more information, visit the [Creative Commons](https://creativecommons.org/licenses/by-sa/4.0/) website.',
     },
   },
 

shared/validation/song/constants.ts

@@ -47,6 +47,7 @@
     "react-infinite-scroll-component": "^6.1.0",
     "react-loading-skeleton": "^3.4.0",
     "react-markdown": "^9.0.1",
+    "schema-dts": "^1.1.2",
     "sharp": "^0.33.4",
     "tailwind-merge": "^2.2.1",
     "tailwindcss": "3.4.1",

web/package.json

@@ -0,0 +1 @@
+google.com, pub-2486912467787383, DIRECT, f08c47fec0942fa0

web/public/ads.txt

@@ -7,6 +7,7 @@ import NextTopLoader from 'nextjs-toploader';
 import { Toaster } from 'react-hot-toast';
 import 'react-loading-skeleton/dist/skeleton.css';
 import { SkeletonTheme } from 'react-loading-skeleton';
+import { WebSite, WithContext } from 'schema-dts';
 
 import GoogleAdSense from '../modules/shared/components/GoogleAdSense';
 import { TooltipProvider } from '../modules/shared/components/tooltip';
@@ -18,7 +19,8 @@ const lato = Lato({
 
 export const metadata: Metadata = {
   title: { template: '%s | Note Block World', default: '' },
-  description: 'Discover, share and listen to note block music',
+  description:
+    'Discover, share and listen to note block music from all around the world',
   applicationName: 'Note Block World',
   keywords: ['note block', 'music', 'minecraft', 'nbs', 'note block studio'],
   openGraph: {
@@ -30,6 +32,15 @@ export const metadata: Metadata = {
   },
 };
 
+const jsonLd: WithContext<WebSite> = {
+  '@context': 'https://schema.org',
+  '@type': 'WebSite',
+  name: 'Note Block World',
+  url: process.env.NEXT_PUBLIC_URL,
+  description:
+    'Discover, share and listen to note block music from all around the world',
+};
+
 export default function RootLayout({
   children,
 }: {
@@ -40,6 +51,11 @@ export default function RootLayout({
       <html lang='en'>
         <head>
           <GoogleAdSense pId={process.env.NEXT_PUBLIC_ADSENSE_CLIENT} />
+          {/* https://nextjs.org/docs/app/building-your-application/optimizing/metadata#json-ld */}
+          <script
+            type='application/ld+json'
+            dangerouslySetInnerHTML={{ __html: JSON.stringify(jsonLd) }}
+          />
           <link
             rel='apple-touch-icon'
             sizes='180x180'