🔀 :: (#62) - BuildConfig를 사용할 수 있도록 하였습니다.

[audgns10]

💡 개요

• local.properties에 baseUrl 값을 넣어 해당 정보를 보호할 수 있게 하도록 하면 Remote 저장소에는 Push가 되지 않으므로 이를 사용하기 위해 BuildConfig를 사용할 필요가 있어보였습니다.

📃 작업내용

• BuildConfig를 세팅하고 이를 적용시켰습니다.

🔀 변경사항

• chore build.gradle.kts(:core:network)
• chore NetworkModule
• chore expo_ci.yml File

🙋‍♂️ 질문사항

• 개선할 점, 오타, 코드에 이산한 부분이 있다면 Comment 달아주세요.

🍴 사용방법

• BASE_URL을 사용할 부분에 buildConfig.BASE_URL 이런식으로 사용해서 원래있던 문자열 대신 넣어주면 됩니다.

🎸 기타

• x

Summary by CodeRabbit

• 새로운 기능

  • CI 워크플로우에 local.properties 파일 생성 단계 추가.
  • Retrofit 인스턴스의 기본 URL을 빌드 구성에서 동적으로 가져오도록 업데이트.

• 버그 수정

  • build.gradle.kts 파일에서 API 키를 로드하는 기능 추가.

• 문서화

  • 코드 구조 변경에 대한 주석 추가.

[coderabbitai]

Walkthrough

이 변경 사항은 Android CI 워크플로우와 네트워크 모듈의 Gradle 설정을 업데이트합니다. .github/workflows/expo_ci.yml 파일에 local.properties 파일을 생성하는 단계가 추가되어, CI 과정에서 LOCAL_PROPERTIES 비밀이 이 파일에 기록됩니다. core/network/build.gradle.kts 파일에서는 BASE_URL을 정의하는 buildConfigField가 추가되었고, getApiKey 함수가 구현되었습니다. 마지막으로, NetworkModule.kt에서 Retrofit 인스턴스의 기본 URL을 BuildConfig.BASE_URL로 업데이트했습니다.

Changes

파일 경로	변경 요약
.github/workflows/expo_ci.yml	local.properties 파일 생성 단계 추가 (- name: Create LOCAL_PROPERTIES)
core/network/build.gradle.kts	FileInputStream 및 Properties 임포트 추가, buildConfig 기능 활성화, BASE_URL을 위한 buildConfigField 추가, getApiKey 함수 구현
core/network/src/main/java/com/school_of_company/network/di/NetworkModule.kt	Retrofit 인스턴스의 기본 URL을 BuildConfig.BASE_URL로 업데이트

Possibly related PRs

• 🔀 :: (#28) - 네트워크 통신을 하기위한 세팅을 했습니다. #29: 이 PR은 NetworkModule.kt의 provideRetrofitInstance 메서드 수정과 관련이 있으며, local.properties 파일을 통해 네트워크 요청의 기본 URL을 가져오는 것과 연결됩니다.
• 🔀 :: (#58) - 통신을 하기 위해 ApiHandler를 구현하였습니다. #59: 이 PR은 build.gradle.kts 파일을 업데이트하며, 두 PR 모두 네트워크 모듈 설정에 관련된 의존성과 구성을 변경합니다.

Suggested reviewers

• diejdkll
• Chaejongin12
• Xixn2

Poem

🐇 변화의 바람이 불어와,
새로운 속성이 생겨나.
local.properties와 함께,
네트워크가 더 강해지네.
빌드의 기쁨을 함께 나누고,
모두의 꿈을 이루는 길로! 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 4

🧹 Outside diff range and nitpick comments (2)

.github/workflows/expo_ci.yml (1)

40-41: 좋은 변경사항입니다. 보안을 위한 제안이 있습니다.

local.properties 파일을 생성하는 단계를 추가한 것은 좋은 접근 방식입니다. 이를 통해 민감한 정보를 안전하게 관리할 수 있습니다.

보안을 더욱 강화하기 위해 다음과 같은 개선을 고려해 보세요:

      - name: Create LOCAL_PROPERTIES
-       run: echo '${{ secrets.LOCAL_PROPERTIES }}' > ./local.properties
+       run: |
+         echo '${{ secrets.LOCAL_PROPERTIES }}' > ./local.properties
+         chmod 600 ./local.properties

이렇게 하면 local.properties 파일의 권한을 제한하여 보안을 강화할 수 있습니다.

core/network/build.gradle.kts (1)

15-19: 환경별로 BASE_URL을 관리하도록 개선하세요

현재 BASE_URL을 local.properties에서 읽어오도록 설정하셨지만, 빌드 타입이나 환경(dev, staging, production)에 따라 다른 URL을 사용해야 할 수 있습니다. 이를 위해 buildConfigField를 빌드 타입별로 설정하는 것을 고려해보세요.

예를 들어, 아래와 같이 빌드 타입별로 BASE_URL을 설정할 수 있습니다:

android {
    buildTypes {
        debug {
            buildConfigField("String", "BASE_URL", "\"${getApiKey("DEBUG_BASE_URL")}\"")
        }
        release {
            buildConfigField("String", "BASE_URL", "\"${getApiKey("RELEASE_BASE_URL")}\"")
        }
    }
}

이렇게 하면 각 빌드 타입에 맞는 URL을 사용할 수 있어 유연성이 높아집니다.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ccdf666 and b2bd687.

📒 Files selected for processing (3)

• .github/workflows/expo_ci.yml (1 hunks)
• core/network/build.gradle.kts (2 hunks)
• core/network/src/main/java/com/school_of_company/network/di/NetworkModule.kt (2 hunks)

🧰 Additional context used

🔇 Additional comments (2)

core/network/src/main/java/com/school_of_company/network/di/NetworkModule.kt (2)

5-5: BuildConfig 가져오기 추가 승인

BuildConfig를 가져오는 것은 BASE_URL을 안전하게 관리하기 위한 좋은 접근 방식입니다. 이는 PR의 목표와 일치하며 민감한 정보를 보호하는 데 도움이 됩니다.

---

69-69: BuildConfig.BASE_URL 사용 승인 및 검증 제안

BuildConfig.BASE_URL을 사용하여 기본 URL을 설정하는 것은 좋은 변경사항입니다. 이는 코드에서 직접적으로 URL을 노출하지 않아 보안을 향상시킵니다.

다음 스크립트를 실행하여 코드베이스 전체에서 하드코딩된 기본 URL이 없는지 확인하세요:

이 검증 단계를 통해 모든 하드코딩된 URL이 제거되었는지 확인할 수 있습니다.

✅ Verification successful

BuildConfig.BASE_URL 사용 검증 완료

코드베이스 전반에서 하드코딩된 기본 URL이 발견되지 않았으며, 이전에 발견된 URL들은 설정 파일과 테스트 파일에 국한되어 있습니다. NetworkModule.kt에서 BuildConfig.BASE_URL을 사용한 변경 사항이 올바르게 적용되었습니다.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 하드코딩된 URL 패턴을 검색합니다.
rg --type kotlin --type java 'http[s]?://[^\s/$.?#].[^\s]*'

Length of output: 2805