-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Track API key creation and last usage
In order to avoid introducing additional latency to requests, API key usage is buffered in-memory and asynchronously flushed to the database in intervals of 30s. An API key counts as "used" if authentication with it succeeds. Also, add support for an optional comment for API keys, as requested in #430 and #536. Closes #362 Closes #430 Closes #536 Signed-off-by: nscuro <nscuro@protonmail.com>
- Loading branch information
Showing
4 changed files
with
220 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
166 changes: 166 additions & 0 deletions
166
alpine-server/src/main/java/alpine/server/filters/ApiKeyUsageTracker.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| /* | ||
| * This file is part of Alpine. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * Copyright (c) Steve Springett. All Rights Reserved. | ||
| */ | ||
| package alpine.server.filters; | ||
|
|
||
| import alpine.common.logging.Logger; | ||
| import alpine.event.framework.LoggableUncaughtExceptionHandler; | ||
| import alpine.model.ApiKey; | ||
| import alpine.persistence.AlpineQueryManager; | ||
| import org.apache.commons.lang3.concurrent.BasicThreadFactory; | ||
| import org.glassfish.jersey.server.monitoring.ApplicationEvent; | ||
| import org.glassfish.jersey.server.monitoring.ApplicationEventListener; | ||
| import org.glassfish.jersey.server.monitoring.RequestEvent; | ||
| import org.glassfish.jersey.server.monitoring.RequestEventListener; | ||
|
|
||
| import javax.jdo.PersistenceManager; | ||
| import javax.jdo.PersistenceManagerFactory; | ||
| import javax.jdo.datastore.JDOConnection; | ||
| import javax.ws.rs.ext.Provider; | ||
| import java.sql.Connection; | ||
| import java.sql.PreparedStatement; | ||
| import java.sql.SQLException; | ||
| import java.sql.Timestamp; | ||
| import java.time.Instant; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.concurrent.ArrayBlockingQueue; | ||
| import java.util.concurrent.BlockingQueue; | ||
| import java.util.concurrent.Executors; | ||
| import java.util.concurrent.ScheduledExecutorService; | ||
| import java.util.concurrent.TimeUnit; | ||
| import java.util.concurrent.locks.Lock; | ||
| import java.util.concurrent.locks.ReentrantLock; | ||
|
|
||
| @Provider | ||
| public class ApiKeyUsageTracker implements ApplicationEventListener { | ||
|
|
||
| private record ApiKeyUsedEvent(long keyId, long timestamp) { | ||
| } | ||
|
|
||
| private static final Logger LOGGER = Logger.getLogger(ApiKeyUsageTracker.class); | ||
| private static final BlockingQueue<ApiKeyUsedEvent> EVENT_QUEUE = new ArrayBlockingQueue<>(10_000); | ||
|
|
||
| private final ScheduledExecutorService flushExecutor; | ||
| private final Lock flushLock; | ||
|
|
||
| public ApiKeyUsageTracker() { | ||
| final var threadFactory = new BasicThreadFactory.Builder() | ||
| .uncaughtExceptionHandler(new LoggableUncaughtExceptionHandler()) | ||
| .namingPattern("Alpine-ApiKeyUsageTracker-%d") | ||
| .build(); | ||
| this.flushExecutor = Executors.newSingleThreadScheduledExecutor(threadFactory); | ||
| this.flushLock = new ReentrantLock(); | ||
| } | ||
|
|
||
| @Override | ||
| public void onEvent(final ApplicationEvent event) { | ||
| switch (event.getType()) { | ||
| case INITIALIZATION_FINISHED -> flushExecutor.scheduleAtFixedRate(this::flush, 5, 30, TimeUnit.SECONDS); | ||
| case DESTROY_FINISHED -> { | ||
| flushExecutor.shutdown(); | ||
| try { | ||
| final boolean terminated = flushExecutor.awaitTermination(5, TimeUnit.SECONDS); | ||
| if (!terminated) { | ||
| LOGGER.warn(""" | ||
| Flush executor did not terminate on time (waited for 5s); \ | ||
| Remaining events in the queue: %d""".formatted(EVENT_QUEUE.size())); | ||
| } | ||
| } catch (InterruptedException e) { | ||
| LOGGER.warn("Interrupted while waiting for pending flush tasks to complete"); | ||
| Thread.currentThread().interrupt(); | ||
| } | ||
|
|
||
| flush(); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public RequestEventListener onRequest(final RequestEvent requestEvent) { | ||
| return null; | ||
| } | ||
|
|
||
| static void onApiKeyUsed(final ApiKey apiKey) { | ||
| final var event = new ApiKeyUsedEvent(apiKey.getId(), Instant.now().toEpochMilli()); | ||
| if (!EVENT_QUEUE.offer(event)) { | ||
| // Prefer lost events over blocking when the queue is saturated. | ||
| // We do not want to add additional latency to requests. | ||
| LOGGER.debug("Usage of API key %s can not be tracked because the event queue is already saturated" | ||
| .formatted(apiKey.getMaskedKey())); | ||
| } | ||
| } | ||
|
|
||
| private void flush() { | ||
| try { | ||
| flushLock.lock(); | ||
| if (EVENT_QUEUE.isEmpty()) { | ||
| return; | ||
| } | ||
|
|
||
| final var lastUsedByKeyId = new HashMap<Long, Long>(); | ||
| while (EVENT_QUEUE.peek() != null) { | ||
| final ApiKeyUsedEvent event = EVENT_QUEUE.poll(); | ||
| lastUsedByKeyId.compute(event.keyId(), (ignored, prev) -> { | ||
| if (prev == null) { | ||
| return event.timestamp(); | ||
| } | ||
|
|
||
| return Math.max(prev, event.timestamp()); | ||
| }); | ||
| } | ||
|
|
||
| LOGGER.debug("Updating last used timestamps for %d API keys".formatted(lastUsedByKeyId.size())); | ||
| updateLastUsed(lastUsedByKeyId); | ||
| } catch (Exception e) { | ||
| LOGGER.error("Failed to update last used timestamps of API keys", e); | ||
| } finally { | ||
| flushLock.unlock(); | ||
| } | ||
| } | ||
|
|
||
| private void updateLastUsed(final Map<Long, Long> lastUsedByKeyId) throws SQLException { | ||
| try (final var qm = new AlpineQueryManager()) { | ||
| final PersistenceManager pm = qm.getPersistenceManager(); | ||
| final var jdoConnection = (JDOConnection) pm.getDataStoreConnection(); | ||
| final var connection = (Connection) jdoConnection.getNativeConnection(); | ||
| try (final PreparedStatement ps = connection.prepareStatement(""" | ||
| UPDATE "APIKEY" SET "LAST_USED" = ? | ||
| WHERE "ID" = ? AND ("LAST_USED" IS NULL OR "LAST_USED" < ?) | ||
| """)) { | ||
| for (final Map.Entry<Long, Long> entry : lastUsedByKeyId.entrySet()) { | ||
| final var lastUsed = new Timestamp(entry.getValue()); | ||
| ps.setTimestamp(1, lastUsed); | ||
| ps.setLong(2, entry.getKey()); | ||
| ps.setTimestamp(3, lastUsed); | ||
| ps.addBatch(); | ||
| } | ||
|
|
||
| ps.executeBatch(); | ||
| } finally { | ||
| jdoConnection.close(); | ||
| } | ||
|
|
||
| // Evict ApiKey objects from L2 cache. | ||
| // DataNucleus does the same when using the bulk UPDATE feature ¯\_(ツ)_/¯ | ||
| final PersistenceManagerFactory pmf = pm.getPersistenceManagerFactory(); | ||
| pmf.getDataStoreCache().evictAll(false, ApiKey.class); | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters