Merge pull request #15 from increments/change-user-agent

API リクエスト時に UserAgent を設定した

Author: ohakutsu

src/commands/login.ts

@@ -2,6 +2,7 @@ import arg from "arg";
 import process from "node:process";
 import readline from "node:readline/promises";
 import { config } from "../lib/config";
+import { getQiitaApiInstance } from "../lib/get-qiita-api-instance";
 import { QiitaApi } from "../qiita-api";
 
 export const login = async (argv: string[]) => {
@@ -15,9 +16,7 @@ export const login = async (argv: string[]) => {
   const token = await rl.question("Enter your token: ");
   rl.close();
 
-  const qiitaApi = new QiitaApi({
-    token,
-  });
+  const qiitaApi = await getQiitaApiInstance({ token });
   const currentUser = await qiitaApi.authenticatedUser();
 
   await config.setCredential({

src/commands/preview.ts

@@ -1,18 +1,15 @@
 import arg from "arg";
 import { config } from "../lib/config";
 import { getFileSystemRepo } from "../lib/get-file-system-repo";
+import { getQiitaApiInstance } from "../lib/get-qiita-api-instance";
 import { syncArticlesFromQiita } from "../lib/sync-articles-from-qiita";
 import { QiitaApi } from "../qiita-api";
 import { startLocalChangeWatcher, startServer } from "../server/app";
 
 export const preview = async (argv: string[]) => {
   const args = arg({}, { argv });
 
-  const { accessToken } = await config.getCredential();
-
-  const qiitaApi = new QiitaApi({
-    token: accessToken,
-  });
+  const qiitaApi = await getQiitaApiInstance();
   const fileSystemRepo = await getFileSystemRepo();
 
   await syncArticlesFromQiita({ fileSystemRepo, qiitaApi });

src/commands/publish.ts

@@ -4,6 +4,7 @@ import { checkFrontmatterType } from "../lib/check-frontmatter-type";
 import { config } from "../lib/config";
 import { QiitaItem } from "../lib/entities/qiita-item";
 import { getFileSystemRepo } from "../lib/get-file-system-repo";
+import { getQiitaApiInstance } from "../lib/get-qiita-api-instance";
 import { syncArticlesFromQiita } from "../lib/sync-articles-from-qiita";
 import { validateItem } from "../lib/validators/item-validator";
 import { Item, QiitaApi } from "../qiita-api";
@@ -16,11 +17,7 @@ export const publish = async (argv: string[]) => {
     { argv }
   );
 
-  const { accessToken } = await config.getCredential();
-
-  const qiitaApi = new QiitaApi({
-    token: accessToken,
-  });
+  const qiitaApi = await getQiitaApiInstance();
   const fileSystemRepo = await getFileSystemRepo();
 
   await syncArticlesFromQiita({ fileSystemRepo, qiitaApi });

src/commands/pull.ts

@@ -1,18 +1,15 @@
 import arg from "arg";
 import { config } from "../lib/config";
 import { getFileSystemRepo } from "../lib/get-file-system-repo";
+import { getQiitaApiInstance } from "../lib/get-qiita-api-instance";
 import { syncArticlesFromQiita } from "../lib/sync-articles-from-qiita";
 import { QiitaApi } from "../qiita-api";
 import { startLocalChangeWatcher, startServer } from "../server/app";
 
 export const pull = async (argv: string[]) => {
   const args = arg({}, { argv });
 
-  const { accessToken } = await config.getCredential();
-
-  const qiitaApi = new QiitaApi({
-    token: accessToken,
-  });
+  const qiitaApi = await getQiitaApiInstance();
   const fileSystemRepo = await getFileSystemRepo();
 
   await syncArticlesFromQiita({ fileSystemRepo, qiitaApi });

src/commands/version.ts

@@ -1,15 +1,5 @@
-import fs from "node:fs/promises";
-import path from "node:path";
-
-const packageJsonFilePath = path.join(__dirname, "../../package.json");
+import { PackageSettings } from "../lib/package-settings";
 
 export const version = async () => {
-  const data = await fs.readFile(packageJsonFilePath, { encoding: "utf8" });
-  const { version } = JSON.parse(data);
-
-  if (!version) {
-    throw new Error("Error: version is not found");
-  }
-
-  console.log(version);
+  console.log(PackageSettings.version);
 };

src/lib/get-qiita-api-instance.ts

@@ -0,0 +1,22 @@
+import { QiitaApi } from "../qiita-api";
+import { config } from "./config";
+import { PackageSettings } from "./package-settings";
+
+let qiitaApi: QiitaApi;
+
+export const getQiitaApiInstance = async (options?: { token?: string }) => {
+  if (!qiitaApi) {
+    qiitaApi = new QiitaApi({
+      token: await accessToken(options),
+      userAgent: userAgent(),
+    });
+  }
+  return qiitaApi;
+};
+
+const accessToken = async (options?: { token?: string }) =>
+  options?.token ?? (await config.getCredential()).accessToken;
+
+const userAgent = () => {
+  return `${PackageSettings.userAgentName}/${PackageSettings.version}`;
+};

src/lib/package-settings.ts

@@ -0,0 +1,6 @@
+const packageJsonData = require("../../package.json");
+
+export const PackageSettings = {
+  userAgentName: "QiitaCLI",
+  version: packageJsonData.version,
+};

src/qiita-api/index.ts

@@ -17,9 +17,18 @@ export interface Item {
 
 export class QiitaApi {
   private readonly token: string;
+  private readonly userAgent: string;
 
-  constructor({ token }: { token: string }) {
+  static agentName = "QiitaApi";
+  static version = "0.0.1";
+
+  constructor({ token, userAgent }: { token: string; userAgent?: string }) {
     this.token = token;
+    this.userAgent = userAgent ? userAgent : QiitaApi.defaultUserAgent();
+  }
+
+  static defaultUserAgent() {
+    return `${QiitaApi.agentName}/${QiitaApi.version}`;
   }
 
   private getUrlScheme() {
@@ -49,6 +58,7 @@ export class QiitaApi {
         headers: {
           Authorization: `Bearer ${this.token}`,
           "Content-Type": "application/json",
+          "User-Agent": this.userAgent,
         },
         ...options,
       });

src/server/api/items.ts

@@ -2,6 +2,7 @@ import type Express from "express";
 import { Router } from "express";
 import { config } from "../../lib/config";
 import { getFileSystemRepo } from "../../lib/get-file-system-repo";
+import { getQiitaApiInstance } from "../../lib/get-qiita-api-instance";
 import { itemsShowPath } from "../../lib/qiita-cli-url";
 import { validateItem } from "../../lib/validators/item-validator";
 import type {
@@ -79,8 +80,7 @@ const itemsShow = async (req: Express.Request, res: Express.Response) => {
   // const { data, itemPath, modified, published } = ;
   const { itemPath, modified, published } = item;
 
-  const { accessToken } = await config.getCredential();
-  const qiitaApi = new QiitaApi({ token: accessToken });
+  const qiitaApi = await getQiitaApiInstance();
   const renderedBody = await qiitaApi.preview(item.rawBody);
 
   const currentUser = await getCurrentUser();
@@ -139,8 +139,7 @@ const itemsUpdate = async (req: Express.Request, res: Express.Response) => {
     return;
   }
 
-  const { accessToken } = await config.getCredential();
-  const qiitaApi = new QiitaApi({ token: accessToken });
+  const qiitaApi = await getQiitaApiInstance();
   let output: { [key: string]: string | boolean } = {
     success: true,
     uuid: result.id || "",

src/server/api/readme.ts

@@ -3,6 +3,7 @@ import { Router } from "express";
 import fs from "node:fs/promises";
 import path from "node:path";
 import { config } from "../../lib/config";
+import { getQiitaApiInstance } from "../../lib/get-qiita-api-instance";
 import { QiitaApi } from "../../qiita-api";
 
 const readmeIndex = async (req: Express.Request, res: Express.Response) => {
@@ -11,8 +12,7 @@ const readmeIndex = async (req: Express.Request, res: Express.Response) => {
       path.join(path.resolve(__dirname), "../../../", "README.md"),
       { encoding: "utf8" }
     );
-    const { accessToken } = await config.getCredential();
-    const qiitaApi = new QiitaApi({ token: accessToken });
+    const qiitaApi = await getQiitaApiInstance();
     const renderedBody = await qiitaApi.preview(fileContent);
 
     res.json({