api: rephrase error message (#2264)

* api: rephrase error message

* ci: run prettier on whole codebase

* ci: run prettier

* fix styling issue

* prettier

packages/api/src/app-router.ts

@@ -80,7 +80,7 @@ export async function initDb(params: CliArgs, serviceName = "api") {
  ...pgBaseParams,
  poolMaxSize: pgJobsPoolSize,
  appName: `${appName}-jobs`,
- },
+ }
  );
  return { db, jobsDb, store };
 }
@@ -111,7 +111,7 @@ export async function initClients(params: CliArgs, serviceName = "api") {
 
  if (!stripeSecretKey) {
  console.warn(
- "Warning: Missing Stripe API key. In development, make sure to configure one in .env.local file.",
+ "Warning: Missing Stripe API key. In development, make sure to configure one in .env.local file."
  );
  }
  const stripe = stripeSecretKey
@@ -155,7 +155,7 @@ export default async function appRouter(params: CliArgs) {
  if (supportAddr || sendgridTemplateId || sendgridApiKey) {
  if (!(supportAddr && sendgridTemplateId && sendgridApiKey)) {
  throw new Error(
- `Sending emails requires supportAddr, sendgridTemplateId, and sendgridApiKey`,
+ `Sending emails requires supportAddr, sendgridTemplateId, and sendgridApiKey`
  );
  }
  }
@@ -220,7 +220,7 @@ export default async function appRouter(params: CliArgs) {
  exposedHeaders: ["*"],
  },
  },
- }),
+ })
  );
 
  // stripe webhook requires raw body
@@ -241,7 +241,7 @@ export default async function appRouter(params: CliArgs) {
  if (returnRegionInOrchestrator) {
  app.use((req, res, next) => {
  req.orchestratorsGetters.push(() =>
- regionsGetter(halfRegionOrchestratorsUntrusted),
+ regionsGetter(halfRegionOrchestratorsUntrusted)
  );
  return next();
  });
@@ -251,7 +251,7 @@ export default async function appRouter(params: CliArgs) {
  app.use(
  subgraph({
  subgraphUrl,
- }),
+ })
  );
  }
 
@@ -261,7 +261,7 @@ export default async function appRouter(params: CliArgs) {
  prefixRouter.get(
  "/stream/:streamId/broadcaster",
  geolocateMiddleware({}),
- getBroadcasterHandler,
+ getBroadcasterHandler
  );
  for (const [name, controller] of Object.entries(controllers)) {
  // if we're operating in api-region mode, only handle geolocation traffic, forward the rest on

packages/api/src/app/stream-info/parse-cli.ts

@@ -12,7 +12,7 @@ export function parseCli() {
 
  Options my also be provided as LP_API_ prefixed environment variables, e.g. LP_API_PORT=5000 is the same as --port=5000.
 
- `,
+ `
  )
  .env("LP_API_")
  //.strict(true)

packages/api/src/app/stream-info/stream-info-app.ts

@@ -200,7 +200,7 @@ class statusPoller {
 
  if (si.stream?.id !== getStreamId(mid)) {
  console.log(
- `stream id changed from ${si.stream?.id} to ${getStreamId(mid)}`,
+ `stream id changed from ${si.stream?.id} to ${getStreamId(mid)}`
  );
  // save the old stream info so it's properly housekept later
  this.seenStreams.set(`old_${mid}_${si.stream?.id}`, si);
@@ -266,7 +266,7 @@ class statusPoller {
 
  private async housekeepSeenStreams(
  activeStreams?: MasterPlaylistDictionary,
- force?: boolean,
+ force?: boolean
  ) {
  for (const [mid, si] of this.seenStreams) {
  if (activeStreams && mid in activeStreams) {
@@ -395,7 +395,7 @@ export default async function makeApp(params: CliArgs) {
  .listen(port, () => {
  listenPort = listener.address().port;
  logger.info(
- `Stream info server listening on http://0.0.0.0:${listenPort}`,
+ `Stream info server listening on http://0.0.0.0:${listenPort}`
  );
  resolve();
  })

packages/api/src/compile-schemas.js

@@ -31,11 +31,11 @@ fs.ensureDirSync(schemaDistDir);
 
 const apiSchemaStr = fs.readFileSync(
  path.resolve(schemaDir, "api-schema.yaml"),
- "utf8",
+ "utf8"
 );
 const dbSchemaStr = fs.readFileSync(
  path.resolve(schemaDir, "db-schema.yaml"),
- "utf8",
+ "utf8"
 );
 const apiData = parseYaml(apiSchemaStr);
 const dbData = parseYaml(dbSchemaStr);

packages/api/src/controllers/access-control.test.ts

@@ -323,7 +323,7 @@ describe("controllers/access-control", () => {
  expect(res3.status).toBe(403);
  let resJson = await res3.json();
  expect(resJson.errors[0]).toBe(
- `Content is gated and origin not in allowed origins`,
+ `Content is gated and origin not in allowed origins`
  );
  const res4 = await client.post("/access-control/gate", {
  stream: `video+${gatedAsset.playbackId}`,
@@ -338,7 +338,7 @@ describe("controllers/access-control", () => {
  expect(res4.status).toBe(403);
  let resJson2 = await res4.json();
  expect(resJson2.errors[0]).toBe(
- "Content is gated and corresponding public key not found",
+ "Content is gated and corresponding public key not found"
  );
  });
 

packages/api/src/controllers/access-control.ts

@@ -42,7 +42,7 @@ type GateConfig = {
 async function fireGateWebhook(
  webhook: DBWebhook,
  content: DBStream | WithID<Asset>,
- payload: AccessControlGatePayload,
+ payload: AccessControlGatePayload
 ) {
  let timestamp = Date.now();
  let jsonPayload = {
@@ -75,7 +75,7 @@ async function fireGateWebhook(
  const sigHeaders = signatureHeaders(
  params.body,
  webhook.sharedSecret,
- timestamp,
+ timestamp
  );
  params.headers = { ...params.headers, ...sigHeaders };
 
@@ -113,7 +113,7 @@ async function fireGateWebhook(
  timestamp,
  statusCode,
  errorMessage,
- undefined,
+ undefined
  );
  }
  if ("pull" in content && content.pull) {
@@ -129,26 +129,26 @@ async function fireGateWebhook(
  `access-control: gate: webhook=${
  webhook.id
  } statusCode=${statusCode} respSpanId=${resp?.headers.get(
- "X-Tlive-Spanid",
+ "X-Tlive-Spanid"
  )} respBody=${Buffer.from(respBody).toString("base64")} duration=${
  process.hrtime(startTime)[1] / 1e6
  }ms accessKey=${payload.accessKey} playbackId=${
  content.playbackId
  } webhook=${
  webhook.id
- } referer=${referer} origin=${origin} playURL=${playURL} playDomain=${playDomain}`,
+ } referer=${referer} origin=${origin} playURL=${playURL} playDomain=${playDomain}`
  );
  } catch (e) {
  console.log(
  `access-control: gate: webhook=${
  webhook.id
  } statusCode=${statusCode} respSpanId=${resp?.headers.get(
- "X-Tlive-Spanid",
+ "X-Tlive-Spanid"
  )} respBody=${Buffer.from(respBody).toString("base64")} duration=${
  process.hrtime(startTime)[1] / 1e6
  }ms accessKey=${payload.accessKey} playbackId=${
  content.playbackId
- } webhook=${webhook.id}`,
+ } webhook=${webhook.id}`
  );
  }
  } else {
@@ -157,7 +157,7 @@ async function fireGateWebhook(
  webhook.id
  } statusCode=${statusCode} duration=${
  process.hrtime(startTime)[1] / 1e6
- }ms`,
+ }ms`
  );
  }
  return statusCode;
@@ -172,7 +172,7 @@ function checkRespBody(resp: string): number | null {
  return body.ret;
  } catch (e) {
  console.log(
- `access-control: error checking response body for status code: ${e}`,
+ `access-control: error checking response body for status code: ${e}`
  );
  }
 }
@@ -192,7 +192,7 @@ app.post(
  (await db.stream.getByPlaybackId(playbackId)) ||
  (await db.asset.getByPlaybackId(playbackId))
  );
- },
+ }
  );
 
  res.set("Cache-Control", "max-age=120,stale-while-revalidate=600");
@@ -261,7 +261,7 @@ app.post(
  if (origin === "null" || origin === "") {
  origin = referer;
  console.log(
- `access-control: gate: origin is null, using referer=${origin} for playbackId=${playbackId}`,
+ `access-control: gate: origin is null, using referer=${origin} for playbackId=${playbackId}`
  );
  }
 
@@ -279,7 +279,7 @@ app.post(
  access-control: gate: content with playbackId=${playbackId} is gated but origin=${origin} not in allowed origins=${allowedOrigins}, disallowing playback
  `);
  throw new ForbiddenError(
- `Content is gated and origin not in allowed origins`,
+ `Content is gated and origin not in allowed origins`
  );
  }
  }
@@ -296,7 +296,7 @@ app.post(
  access-control: gate: no pub provided for playbackId=${playbackId}, disallowing playback
  `);
  throw new ForbiddenError(
- "Content is gated and requires a public key",
+ "Content is gated and requires a public key"
  );
  }
 
@@ -307,15 +307,15 @@ app.post(
  sql`signing_key.data->>'publicKey' = ${req.body.pub}`,
  ];
  return db.signingKey.find(query, { limit: 2 });
- },
+ }
  );
 
  if (signingKeyOutput.length == 0) {
  console.log(`
  access-control: gate: content with playbackId=${playbackId} is gated but corresponding public key not found for key=${req.body.pub}, disallowing playback
  `);
  throw new ForbiddenError(
- "Content is gated and corresponding public key not found",
+ "Content is gated and corresponding public key not found"
  );
  }
 
@@ -325,7 +325,7 @@ app.post(
  access-control: gate: content contentId=${content.id} with playbackId=${playbackId} is gated but multiple (${signingKeyOutput.length}) public keys found for key=${req.body.pub}, disallowing playback, colliding keys=${collisionKeys}
  `);
  throw new BadRequestError(
- "Multiple signing keys found for the same public key.",
+ "Multiple signing keys found for the same public key."
  );
  }
 
@@ -352,7 +352,7 @@ app.post(
  case "webhook":
  if (!req.body.accessKey || req.body.type !== "accessKey") {
  throw new ForbiddenError(
- "Content is gated and requires an access key",
+ "Content is gated and requires an access key"
  );
  }
  const webhook = await db.webhook.get(content.playbackPolicy.webhookId, {
@@ -363,7 +363,7 @@ app.post(
  access-control: gate: content with playbackId=${playbackId} is gated but corresponding webhook not found for webhookId=${content.playbackPolicy.webhookId}, disallowing playback
  `);
  throw new InternalServerError(
- "Content is gated and corresponding webhook not found",
+ "Content is gated and corresponding webhook not found"
  );
  }
 
@@ -379,22 +379,22 @@ app.post(
  access-control: gate: content with playbackId=${playbackId} is gated but webhook=${webhook.id} failed, disallowing playback
  `);
  throw new BadGatewayError(
- "Content is gated and corresponding webhook failed",
+ "Content is gated and corresponding webhook failed"
  );
  } else {
  console.log(`
  access-control: gate: content with playbackId=${playbackId} is gated but webhook=${webhook.id} returned status code ${statusCode}, disallowing playback
  `);
  throw new ForbiddenError(
- "Content is gated and corresponding webhook failed",
+ "Content is gated and corresponding webhook failed"
  );
  }
  default:
  throw new BadRequestError(
- `unknown playbackPolicy type: ${playbackPolicyType}`,
+ `unknown playbackPolicy type: ${playbackPolicyType}`
  );
  }
- },
+ }
 );
 
 app.get("/public-key", async (req, res) => {
@@ -414,7 +414,7 @@ app.get("/public-key", async (req, res) => {
  return response.json();
  } else {
  throw new Error(
- `access-control: error retrieving public key from catalyst statusCode=${response.status} catalystUrl=${url}`,
+ `access-control: error retrieving public key from catalyst statusCode=${response.status} catalystUrl=${url}`
  );
  }
  })

packages/api/src/controllers/admin.js

@@ -117,7 +117,7 @@ app.post(
  i++;
  }
  res.end(`cleaned routes for ${cleaned}/${toClean.length} streams\n`);
- },
+ }
 );
 
 app.post("/active-clean", authorizer({ anyAdmin: true }), async (req, res) => {

packages/api/src/controllers/api-token.js

@@ -116,7 +116,7 @@ app.get("/", async (req, res) => {
  query.push(
  sql`coalesce(api_token.data->>'projectId', ${
  req.user.defaultProjectId || ""
- }) = ${req.project?.id || ""}`,
+ }) = ${req.project?.id || ""}`
  );
  }
 

packages/api/src/controllers/api-token.test.js

@@ -63,7 +63,7 @@ describe("controllers/api-token", () => {
 
  const nonAdminUserRes = await server.store.get(
  `user/${nonAdminUser.id}`,
- false,
+ false
  );
  nonAdminUser = { ...nonAdminUserRes, emailValid: true };
  await server.store.replace(nonAdminUser);