style: rename variable

packages/app/src/server/routes/apiv3/g2g-transfer.ts

@@ -324,9 +324,9 @@ module.exports = (crowi: Crowi): Router => {
   receiveRouter.post('/generate-key', accessTokenParser, adminRequiredIfInstalled, appSiteUrlRequiredIfNotInstalled, async(req: Request, res: ApiV3Response) => {
     const appSiteUrl = req.body.appSiteUrl ?? crowi.configManager?.getConfig('crowi', 'app:siteUrl');
 
-    let appSiteOrigin: string;
+    let appSiteUrlOrigin: string;
     try {
-      appSiteOrigin = new URL(appSiteUrl).origin;
+      appSiteUrlOrigin = new URL(appSiteUrl).origin;
     }
     catch (err) {
       logger.error(err);
@@ -336,7 +336,7 @@ module.exports = (crowi: Crowi): Router => {
     // Save TransferKey document
     let transferKeyString: string;
     try {
-      transferKeyString = await g2gTransferReceiverService.createTransferKey(appSiteOrigin);
+      transferKeyString = await g2gTransferReceiverService.createTransferKey(appSiteUrlOrigin);
     }
     catch (err) {
       logger.error(err);

packages/app/src/server/service/g2g-transfer.ts

@@ -113,12 +113,12 @@ interface Receiver {
   answerGROWIInfo(): Promise<IDataGROWIInfo>
   /**
    * DO NOT USE TransferKeyModel.create() directly, instead, use this method to create a TransferKey document.
-   * This method receives appSiteUrl to create a TransferKey document and returns generated transfer key string.
+   * This method receives appSiteUrlOrigin to create a TransferKey document and returns generated transfer key string.
    * UUID is the same value as the created document's _id.
-   * @param {string} appSiteUrl appSiteUrl
+   * @param {string} appSiteUrlOrigin GROWI app site URL origin
    * @returns {string} Transfer key string (e.g. http://localhost:3000__grw_internal_tranferkey__<uuid>)
    */
-  createTransferKey(appSiteUrl: string): Promise<string>
+  createTransferKey(appSiteUrlOrigin: string): Promise<string>
   /**
    * Receive transfer request and import data.
    * @param {Readable} zippedGROWIDataStream
@@ -128,10 +128,10 @@ interface Receiver {
 }
 
 const generateAxiosRequestConfigWithTransferKey = (tk: TransferKey, additionalHeaders: {[key: string]: string} = {}) => {
-  const { appUrl, key } = tk;
+  const { appSiteUrlOrigin, key } = tk;
 
   return {
-    baseURL: appUrl,
+    baseURL: appSiteUrlOrigin,
     headers: {
       ...additionalHeaders,
       [X_GROWI_TRANSFER_KEY_HEADER_NAME]: key,
@@ -502,9 +502,9 @@ export class G2GTransferReceiverService implements Receiver {
     return generateGROWIInfo(this.crowi);
   }
 
-  public async createTransferKey(appSiteUrl: string): Promise<string> {
+  public async createTransferKey(appSiteUrlOrigin: string): Promise<string> {
     const uuid = new MongooseTypes.ObjectId().toString();
-    const transferKeyString = TransferKey.generateKeyString(uuid, appSiteUrl);
+    const transferKeyString = TransferKey.generateKeyString(uuid, appSiteUrlOrigin);
 
     // Save TransferKey document
     let tkd;

packages/app/src/utils/vo/transfer-key.ts

@@ -1,21 +1,21 @@
 /**
- * VO for TransferKey which has appUrl and key as its public member
+ * VO for TransferKey which has appSiteUrlOrigin and key as its public member
  */
 export class TransferKey {
 
   private static _internalSeperator = '__grw_internal_tranferkey__';
 
-  public appUrl: string;
+  public appSiteUrlOrigin: string;
 
   public key: string;
 
-  constructor(appUrl: string, key: string) {
-    this.appUrl = appUrl;
+  constructor(appSiteUrlOrigin: string, key: string) {
+    this.appSiteUrlOrigin = appSiteUrlOrigin;
     this.key = key;
   }
 
   get getKeyString(): string {
-    return TransferKey.generateKeyString(this.key, this.appUrl);
+    return TransferKey.generateKeyString(this.key, this.appSiteUrlOrigin);
   }
 
   /**
@@ -32,27 +32,27 @@ export class TransferKey {
       throw Error(generalErrorPhrase);
     }
     const key = splitted[0];
-    const appUrlString = splitted[1];
+    const appSiteUrl = splitted[1];
 
-    let appSiteOrigin: string;
+    let appSiteUrlOrigin: string;
     try {
-      appSiteOrigin = new URL(appUrlString).origin;
+      appSiteUrlOrigin = new URL(appSiteUrl).origin;
     }
     catch (e) {
       throw Error(generalErrorPhrase + (e as Error));
     }
 
-    return new TransferKey(appSiteOrigin, key);
+    return new TransferKey(appSiteUrlOrigin, key);
   }
 
   /**
    * Generates transfer key string (e.g. https://example.com:8080__grw_internal_tranferkey__key)
    * @param {string} key Key generated by GROWI
-   * @param {string} appUrl GROWI app site url
+   * @param {string} appSiteUrlOrigin GROWI app site URL origin
    * @returns {string} Transfer key string
    */
-  static generateKeyString(key: string, appUrl: string): string {
-    return `${key}${TransferKey._internalSeperator}${appUrl}`;
+  static generateKeyString(key: string, appSiteUrlOrigin: string): string {
+    return `${key}${TransferKey._internalSeperator}${appSiteUrlOrigin}`;
   }
 
 }