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.

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

v2.2.2 #483

Merged
merged 1 commit into from
Nov 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
55 changes: 33 additions & 22 deletions main/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -23,71 +23,82 @@ repositories {
}

dependencies {
// Spring Boot Dependencies
implementation 'org.springframework.boot:spring-boot-starter-web'
// https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-ui
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0'
implementation 'org.springframework.boot:spring-boot-starter-webflux:3.1.5'
implementation 'org.springframework.boot:spring-boot-starter-actuator'
implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
implementation 'org.springframework.boot:spring-boot-starter-security'

// lombok
// Lombok Dependencies (Compile-time code generation library)
compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'
testCompileOnly 'org.projectlombok:lombok'
testAnnotationProcessor 'org.projectlombok:lombok'

// Development Tools
developmentOnly 'org.springframework.boot:spring-boot-devtools'

// Test Dependencies
testImplementation 'org.springframework.boot:spring-boot-starter-test'
testImplementation 'org.testcontainers:testcontainers:1.17.3'
testImplementation 'org.testcontainers:junit-jupiter:1.16.2'
testImplementation 'org.testcontainers:postgresql:1.17.3'
testImplementation 'org.testcontainers:jdbc'

// Apache Commons Dependencies
implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.14.0'

// AOP (Aspect-Oriented Programming) for cross-cutting concerns
implementation 'org.springframework.boot:spring-boot-starter-aop'

// Database and Persistence Dependencies
implementation group: 'org.postgresql', name: 'postgresql', version: '42.6.0'
implementation 'org.springframework.boot:spring-boot-starter-validation'
implementation 'org.postgresql:postgresql:42.3.0'

// jsonb νƒ€μž… 핸듀링 μœ„ν•¨
// jsonb Type Handling
implementation 'io.hypersistence:hypersistence-utils-hibernate-62:3.6.0'

// JWT Dependencies for Security and Authentication
implementation group: 'io.jsonwebtoken', name: 'jjwt-api', version: '0.11.5'
implementation group: 'io.jsonwebtoken', name: 'jjwt-impl', version: '0.11.5'
implementation group: 'io.jsonwebtoken', name: 'jjwt-jackson', version: '0.11.5'
implementation 'com.auth0:java-jwt:4.4.0'

// h2
// H2 Database (for testing and in-memory DB)
runtimeOnly 'com.h2database:h2'

// mac m1 setting
// macOS M1 Support (Network Resolver for macOS)
implementation 'io.netty:netty-resolver-dns-native-macos:4.1.68.Final:osx-aarch_64'

// Spring Cloud OpenFeign (Service-to-service communication)
implementation 'org.springframework.cloud:spring-cloud-starter-openfeign:4.0.3'

// test container
testImplementation 'org.testcontainers:testcontainers:1.17.3' // TC μ˜μ‘΄μ„±
testImplementation 'org.testcontainers:junit-jupiter:1.16.2' // TC μ˜μ‘΄μ„±
testImplementation 'org.testcontainers:postgresql:1.17.3' // PostgreSQL μ»¨ν…Œμ΄λ„ˆ μ‚¬μš©
testImplementation 'org.testcontainers:jdbc' // DBμ™€μ˜ JDBC connection
implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.14.0'

// aop
implementation 'org.springframework.boot:spring-boot-starter-aop'

// MapStruct
// MapStruct (DTO transformation code generation)
implementation 'org.mapstruct:mapstruct:1.5.3.Final'
annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.3.Final'

// queryDsl
// QueryDSL (JPA Query Generation)
implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
annotationProcessor "com.querydsl:querydsl-apt:${dependencyManagement.importedProperties['querydsl.version']}:jakarta"
annotationProcessor "jakarta.annotation:jakarta.annotation-api"
annotationProcessor "jakarta.persistence:jakarta.persistence-api"

// AWS SDK for S3
// AWS SDK for S3 (for file upload and download)
implementation "software.amazon.awssdk:s3:2.27.0"

// csv κ΄€λ ¨
// CSV Processing Library
implementation 'com.opencsv:opencsv:5.5.2'

// prometheus
// Prometheus (Monitoring and Metrics Collection)
implementation 'io.micrometer:micrometer-registry-prometheus'

// Sentry Logback (Error Tracking)
implementation 'io.sentry:sentry-logback:7.17.0'

// Slack Webhook
implementation 'com.github.maricn:logback-slack-appender:1.4.0'
}

tasks.named('test') {
Expand Down Expand Up @@ -157,4 +168,4 @@ jacocoTestCoverageVerification {
]
}
}
}
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
package org.sopt.makers.crew.main.global.advice;

import java.io.IOException;

import org.sopt.makers.crew.main.global.exception.BaseException;
import org.sopt.makers.crew.main.global.exception.ExceptionResponse;
import org.sopt.makers.crew.main.global.exception.ErrorStatus;
import org.sopt.makers.crew.main.global.exception.ExceptionResponse;
import org.springframework.dao.DataIntegrityViolationException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
Expand Down Expand Up @@ -108,12 +110,19 @@ public ResponseEntity<ExceptionResponse> handleHttpRequestMethodNotSupportedExce
ErrorStatus.INVALID_INPUT_VALUE.getErrorCode()));
}

@ExceptionHandler(IOException.class)
public ResponseEntity<ExceptionResponse> handleIOException(IOException e) {
log.warn("{}", e.getMessage());
return ResponseEntity.status(HttpStatus.BAD_REQUEST)
.body(ExceptionResponse.fail(
ErrorStatus.IO_EXCEPTION.getErrorCode()));
}

@ExceptionHandler(Exception.class)
public ResponseEntity<ExceptionResponse> handleException(Exception e) {
log.error("{}", e.getMessage());
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
.body(ExceptionResponse.fail(
ErrorStatus.INTERNAL_SERVER_ERROR.getErrorCode()));
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ private String[] getAuthWhitelist() {
"/meeting/v2/org-user/**",
"/auth/v2",
"/auth/v2/**",
actuatorEndPoint + "/health"
actuatorEndPoint + "/health",
"/sentry" // prodμ—μ„œ ν…ŒμŠ€νŠΈ ν›„ μ‚­μ œ
};
}

Expand Down Expand Up @@ -103,4 +104,4 @@ CorsConfigurationSource corsConfigurationSource() {
return source;
}

}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package org.sopt.makers.crew.main.global.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;

import io.sentry.Sentry;
import jakarta.annotation.PostConstruct;

@Configuration
public class SentryConfig {

@Value("${sentry.dsn}")
private String sentryDsn;

@Value("${sentry.environment}")
private String environment;

@Value("${sentry.servername}")
private String serverName;

@PostConstruct
public void initSentry() {
Sentry.init(options -> {
options.setDsn(sentryDsn);
options.setEnvironment(environment);
options.setServerName(serverName);
});
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ public enum ErrorStatus {
CO_LEADER_CANNOT_APPLY("곡동 λͺ¨μž„μž₯은 μ‹ μ²­ν•  수 μ—†μŠ΅λ‹ˆλ‹€."),
LEADER_CANNOT_BE_CO_LEADER_APPLY("λͺ¨μž„μž₯은 곡동 λͺ¨μž„μž₯이 될 수 μ—†μŠ΅λ‹ˆλ‹€."),
NOT_ALLOW_MEETING_APPLY("ν—ˆμš©λ˜μ§€ μ•ŠλŠ” λͺ¨μž„ μ‹ μ²­μž…λ‹ˆλ‹€."),
IO_EXCEPTION("파일 μž…μΆœλ ₯ 였λ₯˜κ°€ λ°œμƒν–ˆμŠ΅λ‹ˆλ‹€."),

/**
* 401 UNAUTHORIZED
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package org.sopt.makers.crew.main.global.sentry;

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import io.sentry.Sentry;
import lombok.extern.slf4j.Slf4j;

@Slf4j
@RestController
@RequestMapping("/sentry")
public class SentryController {

@GetMapping
public ResponseEntity<String> testSentry() { // prodμ—μ„œ ν…ŒμŠ€νŠΈ ν›„ μ‚­μ œ
try {
throw new Exception("This is a test exception for Sentry.");
} catch (Exception e) {
Sentry.captureException(e);
log.error("Exception captured in Sentry", e);
return ResponseEntity.status(500).body("Exception captured in Sentry");
}
}
}
13 changes: 13 additions & 0 deletions main/src/main/resources/application-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,16 @@ management:
custom:
paths:
eventApply: ${DEV_EVENT_APPLY_PATH}

sentry:
dsn: ${SENTRY_DSN}
environment: ${DEV_SENTRY_ENVIRONMENT}
servername: ${DEV_SENTRY_SERVERNAME}

logging:
slack:
webhook-uri: ${SENTRY_SLACK_WEBHOOK_URI}
config: classpath:logback-spring.xml
sentry:
repository-uri: ${SENTRY_REPOSITORY_URI}
environment: dev
13 changes: 13 additions & 0 deletions main/src/main/resources/application-prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,16 @@ management:
custom:
paths:
eventApply: ${PROD_EVENT_APPLY_PATH}

sentry:
dsn: ${SENTRY_DSN}
environment: ${PROD_SENTRY_ENVIRONMENT}
servername: ${PROD_SENTRY_SERVERNAME}

logging:
slack:
webhook-uri: ${SENTRY_SLACK_WEBHOOK_URI}
config: classpath:logback-spring.xml
sentry:
repository-uri: ${SENTRY_REPOSITORY_URI}
environment: prod
13 changes: 13 additions & 0 deletions main/src/main/resources/application-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,16 @@ management:
custom:
paths:
eventApply: ${DEV_EVENT_APPLY_PATH}

sentry:
dsn: ${SENTRY_DSN}
environment: ${DEV_SENTRY_ENVIRONMENT}
servername: ${DEV_SENTRY_SERVERNAME}

logging:
slack:
webhook-uri: ${SENTRY_SLACK_WEBHOOK_URI}
config: classpath:logback-spring.xml
sentry:
repository-uri: ${SENTRY_REPOSITORY_URI}
environment: test
38 changes: 35 additions & 3 deletions main/src/main/resources/logback-spring.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,58 @@
<property name="LOG_PATTERN"
value="[%d{yyyy-MM-dd HH:mm:ss}:%-4relative] %green([%thread]) %highlight(%-5level) %boldWhite([%C.%M:%yellow(%L)]) - %msg%n"/>

<appender name="Sentry" class="io.sentry.logback.SentryAppender">
<maxRequestBodySize>always</maxRequestBodySize>
<sendDefaultPii>true</sendDefaultPii>
<tracesSampleRate>1.0</tracesSampleRate>
<minimumEventLevel>ERROR</minimumEventLevel>
<minimumBreadcrumbLevel>DEBUG</minimumBreadcrumbLevel>
</appender>

<springProperty name="SLACK_WEBHOOK_URI" source="logging.slack.webhook-uri"/>
<springProperty name="SENTRY_REPOSITORY_URI" source="logging.sentry.repository-uri"/>
<springProperty name="ENVIRONMENT" source="logging.sentry.environment"/>
<appender name="SLACK" class="com.github.maricn.logback.SlackAppender">
<webhookUri>${SLACK_WEBHOOK_URI}</webhookUri>
<layout class="ch.qos.logback.classic.PatternLayout">
<pattern>*🚨[${ENVIRONMENT}] %d{yyyy-MM-dd HH:mm:ss.SSS} %-4relative [%thread] %-5level %class - %msg &lt;${SENTRY_REPOSITORY_URI}|Go-To-Sentry&gt;*
%n
</pattern>
</layout>
<username>posting bot</username>
<iconEmoji>:robot_face:</iconEmoji>
<colorCoding>true</colorCoding>
</appender>

<appender name="ASYNC_SLACK" class="ch.qos.logback.classic.AsyncAppender">
<appender-ref ref="SLACK"/>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
</appender>

<springProfile name="local">
<include resource="console-appender.xml"/>

<root level="INFO">
<appender-ref ref="CONSOLE"/>
</root>
</springProfile>

<springProfile name="dev">
<include resource="console-appender.xml"/>

<root level="INFO">
<appender-ref ref="CONSOLE"/>
<appender-ref ref="Sentry"/>
<appender-ref ref="ASYNC_SLACK"/>
</root>
</springProfile>

<springProfile name="prod">
<include resource="console-appender.xml"/>
<root level="INFO">
<appender-ref ref="CONSOLE"/>
<appender-ref ref="Sentry"/>
<appender-ref ref="ASYNC_SLACK"/>
</root>
</springProfile>

Expand All @@ -32,4 +64,4 @@
<appender-ref ref="CONSOLE"/>
</root>
</springProfile>
</configuration>
</configuration>
Loading