Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat [#172] Amplitude Setting 및 적용 완료 #173

Merged
merged 11 commits into from
Mar 27, 2024
Merged

Feat [#172] Amplitude Setting 및 적용 완료 #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2e1a37b
[Feat] #172 - Amplitude SPM 설치
boogios Mar 26, 2024
8bc519d
[Feat] #172 - Amplitude App Key 값 추가
boogios Mar 26, 2024
a796ebf
[Feat] #172 - Amplitude App Key 값 초기화
boogios Mar 26, 2024
61bc150
[Feat] #172 - 게시글 작성 Amplitude 추가
boogios Mar 26, 2024
7a80b5b
[Feat] #172 - 답글 작성 Amplitude 추가
boogios Mar 26, 2024
38ac530
[Feat] #172 - 게시글 뷰 조회 Amplitude 추가
boogios Mar 26, 2024
55aadf1
[Feat] #172 - 게시글 좋아요 클릭 Amplitude 추가
boogios Mar 26, 2024
5aa516d
[Feat] #172 - 댓글 좋아요 클릭 Amplitude 추가
boogios Mar 26, 2024
0343b84
[Feat] #172 - 신규 가입 Amplitude 추가
boogios Mar 26, 2024
2b275f5
[Feat] #172 - 계정 삭제 Amplitude 추가
boogios Mar 26, 2024
c150b49
[Release] #172 - Release version 1.0.1
boogios Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions DontBe-iOS/DontBe-iOS.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@
3CF184D12B4EFF9900816D5F /* MyPageProfileView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3CF184D02B4EFF9900816D5F /* MyPageProfileView.swift */; };
3CF4293A2B8F416F00A1524B /* MyPageMemberDeleteDTO.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3CF429392B8F416F00A1524B /* MyPageMemberDeleteDTO.swift */; };
3CF4651B2B58398900997FCA /* PostTransparencyRequestDTO.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3CF4651A2B58398900997FCA /* PostTransparencyRequestDTO.swift */; };
3CFB30472BB305EE00A3F70A /* Amplitude in Frameworks */ = {isa = PBXBuildFile; productRef = 3CFB30462BB305EE00A3F70A /* Amplitude */; };
/* End PBXBuildFile section */

/* Begin PBXFileReference section */
Expand Down Expand Up @@ -326,6 +327,7 @@
files = (
2AAA845F2B494AC50098A824 /* SnapKit in Frameworks */,
2A8D70B12B4C4D8F009F4C6C /* KakaoSDK in Frameworks */,
3CFB30472BB305EE00A3F70A /* Amplitude in Frameworks */,
2FD9276A2B92245B0046193D /* Lottie in Frameworks */,
);
runOnlyForDeploymentPostprocessing = 0;
Expand Down Expand Up @@ -1185,6 +1187,7 @@
2AAA845E2B494AC50098A824 /* SnapKit */,
2A8D70B02B4C4D8F009F4C6C /* KakaoSDK */,
2FD927692B92245B0046193D /* Lottie */,
3CFB30462BB305EE00A3F70A /* Amplitude */,
);
productName = DontBe;
productReference = 3C6192E92B3A719A00220CEB /* DontBe-iOS.app */;
Expand Down Expand Up @@ -1218,6 +1221,7 @@
2AAA845D2B494AC50098A824 /* XCRemoteSwiftPackageReference "SnapKit" */,
2A8D70AF2B4C4D8F009F4C6C /* XCRemoteSwiftPackageReference "kakao-ios-sdk" */,
2FD927682B92245B0046193D /* XCRemoteSwiftPackageReference "lottie-spm" */,
3CFB30452BB305EE00A3F70A /* XCRemoteSwiftPackageReference "Amplitude-iOS" */,
);
productRefGroup = 3C6192EA2B3A719A00220CEB /* Products */;
projectDirPath = "";
Expand Down Expand Up @@ -1546,7 +1550,7 @@
"$(inherited)",
"@executable_path/Frameworks",
);
MARKETING_VERSION = 1.0.0;
MARKETING_VERSION = 1.0.1;
PRODUCT_BUNDLE_IDENTIFIER = "com.SOPT33.DontBe-iOS";
PRODUCT_NAME = "$(TARGET_NAME)";
PROVISIONING_PROFILE_SPECIFIER = "";
Expand Down Expand Up @@ -1583,7 +1587,7 @@
"$(inherited)",
"@executable_path/Frameworks",
);
MARKETING_VERSION = 1.0.0;
MARKETING_VERSION = 1.0.1;
PRODUCT_BUNDLE_IDENTIFIER = "com.SOPT33.DontBe-iOS";
PRODUCT_NAME = "$(TARGET_NAME)";
PROVISIONING_PROFILE_SPECIFIER = "";
Expand Down Expand Up @@ -1644,6 +1648,14 @@
minimumVersion = 4.4.1;
};
};
3CFB30452BB305EE00A3F70A /* XCRemoteSwiftPackageReference "Amplitude-iOS" */ = {
isa = XCRemoteSwiftPackageReference;
repositoryURL = "https://github.com/amplitude/Amplitude-iOS";
requirement = {
branch = main;
kind = branch;
};
};
/* End XCRemoteSwiftPackageReference section */

/* Begin XCSwiftPackageProductDependency section */
Expand All @@ -1662,6 +1674,11 @@
package = 2FD927682B92245B0046193D /* XCRemoteSwiftPackageReference "lottie-spm" */;
productName = Lottie;
};
3CFB30462BB305EE00A3F70A /* Amplitude */ = {
isa = XCSwiftPackageProductDependency;
package = 3CFB30452BB305EE00A3F70A /* XCRemoteSwiftPackageReference "Amplitude-iOS" */;
productName = Amplitude;
};
/* End XCSwiftPackageProductDependency section */
};
rootObject = 3C6192E12B3A719A00220CEB /* Project object */;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

이 코드 패치의 요약:

  1. 새로운 파일 Amplitude가 추가되었습니다.
  2. Amplitude는 Frameworks에 추가되었으며, 이에 대한 설정이 변경되었습니다.
  3. Amplitude-iOS가 XCRemoteSwiftPackageReference로 추가되었습니다.

개선 제안:

  • 코드 변경 전 후의 테스트를 수행하여 새로운 구성의 정상 작동을 확인하세요.
  • 각 파일 및 의존성에 적절한 주석을 추가하여 가독성을 향상시켜주세요.
  • Swift 패키지들의 버전 호환성을 확인하고 업데이트해야 할 필요가 있습니다.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

이 코드 리뷰에서 발견된 잠재적인 버그 위험:

  1. MARKETING_VERSION이 1.0.0에서 1.0.1로 변경되었지만, 이 업데이트에 대한 주석 또는 변경 사항 설명이 없습니다.
  2. 빌드 파일 및 프로젝트 구성에 Amplitude 추가되면서, 해당 종속성이 적절히 관리되고 있는지 확인이 필요합니다.
  3. repositoryURL = "https://github.com/amplitude/Amplitude-iOS";와 같이 외부 종속성 링크를 사용할 때, 네트워크 및 소스 안정성 문제에 유의해야 합니다.

개선 제안:

  1. 변경된 버전(예: MARKETING_VERSION)에 대한 명확한 주석 추가.
  2. 변경사항을 충분히 문서화하여 다른 팀원들이 코드 변경사항을 이해하도록 하기.
  3. 외부 종속성 관리를 개선하기 위해, 주기적으로 코드 베이스를 검토하고 관련 업데이트가 있으면 업데이트하는 프로세스를 설정할 것.

코드 리뷰를 통해 더 나은 협업과 유지보수 가능한 코드베이스를 유지할 수 있도록 하세요.

Expand Down
18 changes: 18 additions & 0 deletions DontBe-iOS/DontBe-iOS.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,24 @@
"version" : "5.8.1"
}
},
{
"identity" : "amplitude-ios",
"kind" : "remoteSourceControl",
"location" : "https://github.com/amplitude/Amplitude-iOS",
"state" : {
"branch" : "main",
"revision" : "d4a71f3e06b5108696ca7b33567d0fc539597d82"
}
},
{
"identity" : "analytics-connector-ios",
"kind" : "remoteSourceControl",
"location" : "https://github.com/amplitude/analytics-connector-ios.git",
"state" : {
"revision" : "e2ca17ac735bcbc48b13062484541702ef45153d",
"version" : "1.0.3"
}
},
{
"identity" : "kakao-ios-sdk",
"kind" : "remoteSourceControl",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

이 코드 패치에는 몇 가지 문제가 있습니다.

  1. "branch" 키가 "main"으로 설정되어 있지만, 최신 버전의 git에서는 기본 브랜치 이름이 "main"이 아니라 "master"로 변경되었습니다. 따라서 "main" 대신 "master"를 사용하는 것이 좋습니다.
  2. "revision" 필드가 한 번은 "d4a71f3e06b5108696ca7b33567d0fc539597d82"로 나타나고 다른 한 번은 "e2ca17ac735bcbc48b13062484541702ef45153d"로 나타납니다. 이러한 일관성 부족은 유지 보수 및 버그 해결을 어렵게 할 수 있습니다. 모두 같은 형식으로 통일하는 것이 좋습니다.

위의 내용들을 고려하여 코드를 수정하시기 바랍니다.

Expand Down
4 changes: 4 additions & 0 deletions DontBe-iOS/DontBe-iOS/Application/AppDelegate.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import AuthenticationServices
import UIKit

import Amplitude
import KakaoSDKCommon

@main
Expand All @@ -26,6 +27,9 @@ class AppDelegate: UIResponder, UIApplicationDelegate {

KakaoSDK.initSDK(appKey: Config.nativeAppKey)

/// Amplitude 설정
Amplitude.instance().initializeApiKey(Config.amplitudeAppKey)

NotificationCenter.default.addObserver(forName: ASAuthorizationAppleIDProvider.credentialRevokedNotification, object: nil, queue: nil) { (Notification) in
// 앱 실행 중 강제로 연결 취소 시 로그인 페이지로 이동
if let sceneDelegate = UIApplication.shared.connectedScenes.first?.delegate as? SceneDelegate {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amplitude를 추가한 코드 패치에 대한 간단한 코드 리뷰:

  1. 장점:

    • Amplitude를 initialize하고 API 키를 설정하는 부분이 보입니다.
    • 주석을 통해 각 라이브러리의 역할 및 설정 목적을 명확하게 설명했습니다.

  2. 개선 사항:

    • Amplitude.initializeApiKey() 메서드가 콜백을 반환할 수 있으므로 초기화 작업 완료를 처리하는 것이 좋습니다.
    • 예외 처리나 오류 처리 부분이 보이지 않으므로, 이를 추가하여 안정성을 개선할 수 있습니다.
    • 일관된 스타일을 유지하기 위해 다른 라이브러리 설정과 일치하도록 코드 스타일을 조정할 수 있습니다.
    • 해당 애플리케이션의 다른 부분에서 사용되는 예시와 같은 디자인 패턴이나 코드 구조에 따라 Amplitude 통합을 개선할 수 있습니다.

  3. 잠재적 버그 리스크:

    • UIApplication.shared.connectedScenes.first?.delegate 부분이 nil을 반환할 수 있으므로 optional chaining을 사용하는 것이 좋습니다.
    • 옵저버가 중복으로 추가되는 경우를 방지하기 위해 addObserver를 호출하기 전에 removeObserver를 호출하거나 옵저버를 한번만 추가하도록 수정하는 것이 좋습니다.

  4. 기타 고려사항:

    • 코드 가독성을 높이기 위해 Amplitude 설정과 관련된 주석을 더 자세히 달아 설명하는 것도 좋습니다.
    • 클래스 또는 메서드 이름에 맞게 명명 규칙을 준수하여 의도를 더 잘 드러낼 수 있습니다.
    • 팀 내에서 일관된 코드 스타일을 유지하고 문서화된 내용과 일치하도록 유지하는 것이 좋습니다.

Expand Down
2 changes: 2 additions & 0 deletions DontBe-iOS/DontBe-iOS/Global/Resources/Info.plist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
</array>
<key>NATIVE_APP_KEY</key>
<string>$(NATIVE_APP_KEY)</string>
<key>AMPLITUDE_APP_KEY</key>
<string>$(AMPLITUDE_APP_KEY)</string>
<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

코드 리뷰:

  1. AMPLITUDE_APP_KEY가 추가되었지만 사용 전에 해당 값을 올바르게 설정했는지 확인해야 합니다.
  2. NSAppTransportSecurity 설정이 완전하지 않을 수 있으므로, 더 엄격한 보안 정책이 필요한지 고려할 필요가 있습니다.

Expand Down
8 changes: 8 additions & 0 deletions DontBe-iOS/DontBe-iOS/Network/Foundation/Config.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ enum Config {
enum Plist {
static let nativeAppKey = "NATIVE_APP_KEY"
static let baseURL = "BASE_URL"
static let amplitudeAppKey = "AMPLITUDE_APP_KEY"
}
}

Expand All @@ -37,4 +38,11 @@ extension Config {
}
return key
}()

static let amplitudeAppKey: String = {
guard let key = Config.infoDictionary[Keys.Plist.amplitudeAppKey] as? String else {
fatalError("AMPLITUDE_APP_KEY is not set in plist for this configuration")
}
return key
}()
}
5 changes: 4 additions & 1 deletion DontBe-iOS/DontBe-iOS/Presentation/Home/ViewModel/HomeViewModel.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@
// Created by yeonsu on 1/8/24.
//

import Combine
import Foundation

import Combine
import Amplitude

final class HomeViewModel: ViewModelType {

Expand Down Expand Up @@ -84,6 +85,8 @@ final class HomeViewModel: ViewModelType {
let statusCode = try await self.postLikeButtonAPI(contentId: value.1)?.status
if statusCode == 201 {
self.toggleLikeButton.send(value.0)

Amplitude.instance().logEvent("click_post_like")
}
}
} catch {
Expand Down
4 changes: 4 additions & 0 deletions DontBe-iOS/DontBe-iOS/Presentation/Join/ViewModels/JoinProfileViewModel.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import Combine
import Foundation
import UIKit

import Amplitude

final class JoinProfileViewModel: ViewModelType {

private let cancelBag = CancelBag()
Expand Down Expand Up @@ -71,6 +73,8 @@ final class JoinProfileViewModel: ViewModelType {
profileImage: value.profile_image)

self.pushOrPopViewController.send(1)

Amplitude.instance().logEvent("click_account_join_done")
}
saveUserData(UserInfo(isSocialLogined: true,
isFirstUser: true,
Expand Down
4 changes: 4 additions & 0 deletions DontBe-iOS/DontBe-iOS/Presentation/MyPage/ViewModels/MyPageAccountInfoViewModel.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
import Combine
import Foundation

import Amplitude

final class MyPageAccountInfoViewModel: ViewModelType {
private let cancelBag = CancelBag()
private let networkProvider: NetworkServiceType
Expand Down Expand Up @@ -53,6 +55,8 @@ final class MyPageAccountInfoViewModel: ViewModelType {
if let accessToken = KeychainWrapper.loadToken(forKey: "accessToken") {
if let result = try await self.deleteMemberAPI(accessToken: accessToken, deletedReason: deletedReason) {
self.isSignOutResult.send(result.status)

Amplitude.instance().logEvent("click_account_delete_done")
}
}
} catch {
Expand Down
8 changes: 8 additions & 0 deletions DontBe-iOS/DontBe-iOS/Presentation/Post/ViewModel/PostDetailViewModel.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
import Foundation
import Combine

import Amplitude

final class PostDetailViewModel: ViewModelType {

private let cancelBag = CancelBag()
Expand Down Expand Up @@ -65,6 +67,8 @@ final class PostDetailViewModel: ViewModelType {
if let data = postResult?.data {
self.isLikeButtonClicked = data.isLiked
self.getPostData.send(data)

Amplitude.instance().logEvent("click_post_view")
}
}
} catch {
Expand All @@ -87,6 +91,8 @@ final class PostDetailViewModel: ViewModelType {
let statusCode = try await self.postLikeButtonAPI(contentId: value.1)?.status
if statusCode == 201 {
self.toggleLikeButton.send(value.0)

Amplitude.instance().logEvent("click_post_like")
}
}
} catch {
Expand Down Expand Up @@ -135,6 +141,8 @@ final class PostDetailViewModel: ViewModelType {
let statusCode = try await self.postCommentLikeButtonAPI(commentId: value.1, alarmText: value.2)?.status
if statusCode == 201 {
self.toggleCommentLikeButton.send(value.0)

Amplitude.instance().logEvent("click_reply_like")
}
}
} catch {
Expand Down
4 changes: 4 additions & 0 deletions DontBe-iOS/DontBe-iOS/Presentation/Post/ViewModel/WriteReplyViewModel.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
import Foundation
import Combine

import Amplitude

final class WriteReplyViewModel: ViewModelType {

private let cancelBag = CancelBag()
Expand All @@ -33,6 +35,8 @@ final class WriteReplyViewModel: ViewModelType {
if let resultStatus = try await self.postWriteReplyContentAPI(accessToken: "\(accessToken)", commentText: value.0, contentId: value.1, notificationTriggerType: "comment") {
print(resultStatus.status)
self.popViewController.send(true)

Amplitude.instance().logEvent("click_reply_upload")
}
}
} catch {
Expand Down
4 changes: 4 additions & 0 deletions DontBe-iOS/DontBe-iOS/Presentation/Write/ViewModels/WriteViewModel.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
import Combine
import Foundation

import Amplitude

final class WriteViewModel: ViewModelType {

private let cancelBag = CancelBag()
Expand All @@ -31,6 +33,8 @@ final class WriteViewModel: ViewModelType {
if let accessToken = KeychainWrapper.loadToken(forKey: "accessToken") {
if let resultStatus = try await self.postWriteContentAPI(accessToken: "\(accessToken)", contentText: "\(value)") {
self.popViewController.send(true)

Amplitude.instance().logEvent("click_post_upload")
}
}
} catch {
Expand Down