ci: add typos job and fix typos across the repo

.github/workflows/main.yml

@@ -57,6 +57,13 @@ jobs:
       - name: Ensure generated code is up to date
         run: ./scripts/codegen.sh && git diff --exit-code
 
+  typos:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: typos-action
+        uses: crate-ci/[email protected]
+
   test:
     runs-on: ubuntu-latest
     strategy:

CONTRIBUTING.md

@@ -103,7 +103,7 @@ yarn run dev
 yarn run dev-windows
 ```
 
-Sometimes, you may want to run them seperately so you can use breakpoints to
+Sometimes, you may want to run them separately so you can use breakpoints to
 debug. Using VSCode, this is trivial.
 
 To start the server: `Debug > Select "Launch Program" > Start`

client/src/components/LogInForm.vue

@@ -304,15 +304,15 @@
 					password: password.value,
 				});
 				if (resp.data.success) {
-					console.log("Registeration success");
+					console.log("Registration success");
 					store.commit("LOGIN", resp.data.user);
 					emit("shouldClose");
 					email.value = "";
 					username.value = "";
 					password.value = "";
 					password2.value = "";
 				} else {
-					console.log("Registeration failed");
+					console.log("Registration failed");
 					registerFailureMessage.value = t(
 						"login-form.errors.something-weird-happened"
 					) as string;

client/src/components/RoomSettingsForm.vue

@@ -189,7 +189,7 @@
 		});
 
 		async function loadRoomSettings() {
-			// we have to make an API request becuase visibility is not sent in sync messages.
+			// we have to make an API request because visibility is not sent in sync messages.
 			isLoadingRoomSettings.value = true;
 			try {
 				const res = await API.get<OttApiResponseGetRoom>(`/room/${store.state.room.name}`);

client/src/views/Privacy.vue

@@ -13,7 +13,7 @@
 
 		<p>
 			General site usage, like creating a room, adding videos, etc., are logged to monitor and
-			debug performace. Logs are not kept for more than a week. Logged events are not
+			debug performance. Logs are not kept for more than a week. Logged events are not
 			associated with your account or session.
 		</p>
 

client/src/views/Room.vue

@@ -447,7 +447,7 @@
 		}
 
 		// Indicates that starting playback is blocked by the browser. This usually means that the user needs
-		// to interact with the page before playback can start. This is because browers block autoplaying videos.
+		// to interact with the page before playback can start. This is because browsers block autoplaying videos.
 		const mediaPlaybackBlocked = ref(false);
 
 		async function applyIsPlaying(playing: boolean): Promise<void> {

common/permissions.ts

@@ -230,7 +230,7 @@ export class Grants {
 	masks: RoleGrants = new Map();
 
 	/**
-	 * @param {Object|undefined} grants Opional object that maps roles to grant masks.
+	 * @param {Object|undefined} grants Optional object that maps roles to grant masks.
 	 */
 	constructor(
 		grants: Grants | RoleGrants | OldRoleGrants | [Role, GrantMask][] | undefined = undefined
@@ -250,7 +250,7 @@ export class Grants {
 
 	/**
 	 * Clears all grant masks and replaces them with `grants`.
-	 * @param grants Opional object that maps roles to grant masks.
+	 * @param grants Optional object that maps roles to grant masks.
 	 */
 	setAllGrants(grants: RoleGrants | Grants | OldRoleGrants | [Role, GrantMask][]): void {
 		this.masks = new Map();

common/tests/unit/permissions.spec.ts

@@ -79,7 +79,7 @@ describe("Permission System", () => {
 		);
 	});
 
-	it("should guarentee that using numbers for roles works for Grants", () => {
+	it("should guarantee that using numbers for roles works for Grants", () => {
 		const grants = new Grants({ "0": 4095 });
 		expect(grants.getMask(0)).toEqual(4095);
 	});

common/tests/unit/serialize.spec-d.ts

@@ -10,14 +10,14 @@
 		expectTypeOf<ConvertToJsonSafe<bigint>>().toEqualTypeOf<string>();
 	});
 
-	it("should not convert other primative types", () => {
+	it("should not convert other primitive types", () => {
 		expectTypeOf<ConvertToJsonSafe<number>>().toEqualTypeOf<number>();
 		expectTypeOf<ConvertToJsonSafe<string>>().toEqualTypeOf<string>();
 		expectTypeOf<ConvertToJsonSafe<boolean>>().toEqualTypeOf<boolean>();
 		expectTypeOf<ConvertToJsonSafe<null>>().toEqualTypeOf<null>();
 	});
 
-	it("should not convert arrays of primatives", () => {
+	it("should not convert arrays of primitives", () => {
 		expectTypeOf<ConvertToJsonSafe<number[]>>().toEqualTypeOf<number[]>();
 	});
 

docker/README.md

@@ -38,7 +38,7 @@ cp env/example.toml env/production.toml
 1. Open `env/production.toml` and put your youtube API key in.
 
 2. To build the image locally using the prod image make sure you are in the project root `/opentogethertube`
-   before runing the command below.
+   before running the command below.
 
 ```bash
 docker-compose -f docker/docker-compose.yml up -d

docs/architecture.md

@@ -11,7 +11,7 @@ There are 3 major components to the application:
 
 ## Rooms
 
-In order to accomodate horizontal scaling, there is a `clientmanager` and a `roommanager`. The `clientmanager` manages all websocket connections, and relays all messages for rooms to the `roommanager`. The `roommanger` manages rooms, and relies on the Balancer to ensure that the same room doesn't get loaded twice on different Monoliths. Rooms manage their own state.
+In order to accommodate horizontal scaling, there is a `clientmanager` and a `roommanager`. The `clientmanager` manages all websocket connections, and relays all messages for rooms to the `roommanager`. The `roommanger` manages rooms, and relies on the Balancer to ensure that the same room doesn't get loaded twice on different Monoliths. Rooms manage their own state.
 
 ```mermaid
 graph LR

packages/ott-vis-panel/src/components/TreeDisplay.tsx

@@ -274,7 +274,7 @@ const TreeDisplay: React.FC<TreeDisplayProps> = ({ systemState, width, height })
 			});
 
 			// create nodes for all the balancers evenly spaced along the full height of the monolith trees
-			// but also guarenteeing that they don't overlap with each other or the monoliths with some padding
+			// but also guaranteeing that they don't overlap with each other or the monoliths with some padding
 			const fullHeight = Math.max(...monolithTreeYs);
 			const lerp = d3.interpolateNumber(0, fullHeight);
 			const lerpincr = 1 / (systemState.length - 1);

server/api/data.ts

@@ -118,7 +118,7 @@
 			success: false,
 			error: {
 				name: "Unknown",
-				message: "An unknown error occured. Try again later.",
+				message: "An unknown error occurred. Try again later.",
 			},
 		});
 	}

server/api/room.ts

@@ -483,7 +483,7 @@
 			success: false,
 			error: {
 				name: "Unknown",
-				message: "An unknown error occured. Try again later.",
+				message: "An unknown error occurred. Try again later.",
 			},
 		});
 	}

server/exceptions.ts

@@ -8,9 +8,9 @@
 		let msg = "";
 		let parsed = new URL(url);
 		if (parsed.pathname && /\/*\.([a-z0-9])$/i.exec(parsed.pathname.split("?")[0])) {
-			msg = `If this is a direct link to a video file, please open a "service support request" issue on github, so we can see if this file format works. Otherwise, "${url}" is not a valid URL for any suppported service.`;
+			msg = `If this is a direct link to a video file, please open a "service support request" issue on github, so we can see if this file format works. Otherwise, "${url}" is not a valid URL for any supported service.`;
 		} else {
-			msg = `"${url}" is not a valid URL for any suppported service.`;
+			msg = `"${url}" is not a valid URL for any supported service.`;
 		}
 		super(msg);
 		this.name = "UnsupportedServiceException";

server/infoextractor.ts

@@ -167,7 +167,7 @@
 	getServiceAdapter(service: string): ServiceAdapter {
 		const adapter = adapters.find(adapter => adapter.serviceId === service);
 		if (!adapter) {
-			throw new OttException(`Unkonwn service: ${service}`);
+			throw new OttException(`Unknown service: ${service}`);
 		}
 		return adapter;
 	},

server/redisclient.ts

@@ -237,7 +237,7 @@ async function collectRedisMetrics() {
 	log.silly(`Collected ${countMetricsCollected} redis metrics, skipped ${countMetricsSkipped}`);
 }
 
-const guageRedisDbsize = new Gauge({
+const gaugeRedisDbsize = new Gauge({
 	name: "redis_keys_count",
 	help: "The number of keys in the database",
 	async collect() {

server/roommanager.ts

@@ -252,7 +252,7 @@ const gaugeRoomCount = new Gauge({
 	},
 });
 
-const guageUsersInRooms = new Gauge({
+const gaugeUsersInRooms = new Gauge({
 	name: "ott_users_in_rooms",
 	help: "The number of users that the room manager thinks are in rooms.",
 	collect() {

server/storage.metrics.ts

@@ -23,7 +23,7 @@
 ORDER BY n_live_tup DESC;`;
 
 export function setupPostgresMetricsCollection(sequelize: Sequelize) {
-	const guagePostgresRowCount = new Gauge({
+	const gaugePostgresRowCount = new Gauge({
 		name: "postgres_db_row_count",
 		help: "Number of rows in a table in the database",
 		labelNames: ["table"],
@@ -54,7 +54,7 @@
 		},
 	});
 
-	const guagePostgresTableOps = new Gauge({
+	const gaugePostgresTableOps = new Gauge({
 		name: "postgres_table_ops",
 		help: "Number of table operations in the database",
 		labelNames: ["table", "operation"],

server/tests/unit/api/announcement.spec.ts

@@ -126,7 +126,7 @@ describe("Announcements API", () => {
 		expect(publishSpy).not.toHaveBeenCalled();
 	});
 
-	it("should fail if an unknown error occurrs", async () => {
+	it("should fail if an unknown error occurs", async () => {
 		publishSpy = publishSpy.mockImplementation(() => {
 			throw new Error("fake error");
 		});

server/usermanager.ts

@@ -143,7 +143,7 @@
 		oldUsername = req.user.username;
 		req.user.username = req.body.username;
 		try {
-			// HACK: the unique constrait on the model is fucking broken
+			// HACK: the unique constraint on the model is fucking broken
 			if (await isUsernameTaken(req.body.username)) {
 				throw new UsernameTakenError();
 			}
@@ -607,7 +607,7 @@
 	// eslint-disable-next-line array-bracket-newline
 	const hash = await pwd.hash(Buffer.concat([salt, Buffer.from(password)]));
 
-	// HACK: the unique constrait on the model is fucking broken
+	// HACK: the unique constraint on the model is fucking broken
 	if (await isUsernameTaken(username)) {
 		throw new UsernameTakenError();
 	}
@@ -899,7 +899,7 @@
 			success: false,
 			error: {
 				name: "Unknown",
-				message: "An unknown error occured. Try again later.",
+				message: "An unknown error occurred. Try again later.",
 			},
 		});
 	}

typos.toml

@@ -0,0 +1,19 @@
+[default]
+locale = "en-us"
+
+[default.extend-words]
+guage = "gauge"
+AVOD = "AVOD"
+ser = "ser"
+seeked = "seeked"
+# google drive misspelled this in their API
+aknowledge = "aknowledge"
+
+[files]
+extend-exclude = [
+	"server/tests/unit/fixtures",
+	"server/tests/unit/services/youtube.spec.ts",
+	"server/tests/unit/services/dailymotion.spec.ts",
+	"client/src/locales",
+	"!client/src/locales/en.ts",
+]