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

server/springboot: alter "list tickets" SQL query on the fly #408

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
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
Original file line number Diff line number Diff line change
@@ -1,12 +1,42 @@
package com.styra.tickethub_springboot.dao.model;

import com.styra.tickethub_springboot.App;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.data.domain.Sort;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.jpa.repository.QueryRewriter;
import org.springframework.data.repository.query.Param;
import org.springframework.stereotype.Repository;

import java.util.List;

@Repository
public interface TicketRepository extends JpaRepository<Ticket, Integer> {
List<Ticket> findByTenant(Tenant tenant);
Copy link
Member Author

Choose a reason for hiding this comment

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

☝️ Before, we've let JPA figure out what SQL should be used just from the method signature.

👇 Now, we'll have to spell out the query ourselves.

public interface TicketRepository
extends JpaRepository<Ticket, Integer>, QueryRewriter {
@Query(
value = "SELECT t.id, t.customer, t.description, t.last_updated, t.resolved, t.tenant FROM \"Tickets\" t LEFT JOIN \"Tenants\" t1 ON t1.id=t.tenant WHERE t1.name=:#{#tenant.name}",
nativeQuery = true,
queryRewriter = TicketRepository.class
)
List<Ticket> findByTenant(@Param("tenant") Tenant tenant);

List<Ticket> findByTenantAndId(Tenant tenant, Integer id);

@Override
default String rewrite(String query, Sort sort) {
// Omitted:
// 1. get conditions from OPA, after feeding it query and user information
// 2. convert conditions to SQL WHERE clause
//
// SQL logging uncovered **a lot** of queries happening for "list tickets".
// I'd assume that they're done automatically by Spring Data JPA, to ensure
// relationships etc; but it also means they are under the radar of this rewriter.
// However, I'd envision that there's one rewriter that would be used with all
// the repositories, so maybe we would end up covering call queries after all.
String rewritten = query + " AND t.resolved = false"; // leading space is crucial
Logger logger = LoggerFactory.getLogger(App.class);
logger.info("rewritten: " + rewritten);
return rewritten;
}
}
6 changes: 6 additions & 0 deletions server/springboot/src/main/resources/application.properties
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,9 @@ logging.level.com.styra.tickethub_springboot.dao.model=TRACE
# production, you probably shouldn't do this.
spring.security.user.name=demouser
spring.security.user.password=letmein

# dump all the SQL
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.format_sql=true
logging.level.org.hibernate.SQL=DEBUG
logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE
Loading