add support for rate limit tokens

Author: netomi

server/src/main/java/org/eclipse/openvsx/accesstoken/AccessTokenService.java

@@ -26,7 +26,6 @@
 import org.springframework.stereotype.Service;
 
 import java.time.LocalDateTime;
-import java.util.List;
 import java.util.UUID;
 
 import static org.eclipse.openvsx.util.UrlUtil.createApiUrl;

server/src/main/java/org/eclipse/openvsx/admin/RateLimitAPI.java

@@ -19,13 +19,17 @@
 import org.eclipse.openvsx.repositories.RepositoryService;
 import org.eclipse.openvsx.util.ErrorResultException;
 import org.eclipse.openvsx.util.LogService;
+import org.eclipse.openvsx.util.NotFoundException;
 import org.eclipse.openvsx.util.TimeUtil;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
+import org.springframework.web.server.ResponseStatusException;
 
+import java.util.List;
 import java.util.Optional;
 
 
@@ -34,6 +38,8 @@
 public class RateLimitAPI {
     private final Logger logger = LoggerFactory.getLogger(RateLimitAPI.class);
 
+    private static final int TOKEN_DESCRIPTION_SIZE = 255;
+
     private final RepositoryService repositories;
     private final AdminService admins;
     private final LogService logs;
@@ -59,9 +65,9 @@ public RateLimitAPI(
             produces = MediaType.APPLICATION_JSON_VALUE
     )
     public ResponseEntity<TierListJson> getTiers() {
-        try {
-            admins.checkAdminUser();
+        admins.checkAdminUser();
 
+        try {
             var tiers = repositories.findAllTiers();
             var result = new TierListJson(tiers.stream().map(Tier::toJson).toList());
             return ResponseEntity.ok(result);
@@ -104,6 +110,8 @@ public ResponseEntity<TierJson> createTier(@RequestBody TierJson tier) {
             }
 
             return ResponseEntity.ok(result);
+        } catch (ErrorResultException exc) {
+            return exc.toResponseEntity(TierJson.class);
         } catch (Exception exc) {
             logger.error("failed creating tier {}", tier.getName(), exc);
             return ResponseEntity.internalServerError().build();
@@ -144,6 +152,8 @@ public ResponseEntity<TierJson> updateTier(@PathVariable String name, @RequestBo
             }
 
             return ResponseEntity.ok(result);
+        } catch (ErrorResultException exc) {
+            return exc.toResponseEntity(TierJson.class);
         } catch (Exception exc) {
             logger.error("failed updating tier {}", name, exc);
             return ResponseEntity.internalServerError().build();
@@ -178,6 +188,8 @@ public ResponseEntity<ResultJson> deleteTier(@PathVariable String name) {
             }
 
             return ResponseEntity.ok(result);
+        } catch (ErrorResultException exc) {
+            return exc.toResponseEntity();
         } catch (Exception exc) {
             logger.error("failed deleting tier {}", name, exc);
             return ResponseEntity.internalServerError().build();
@@ -189,9 +201,9 @@ public ResponseEntity<ResultJson> deleteTier(@PathVariable String name) {
             produces = MediaType.APPLICATION_JSON_VALUE
     )
     public ResponseEntity<CustomerListJson> getCustomersForTier(@PathVariable String name) {
-        try {
-            admins.checkAdminUser();
+        admins.checkAdminUser();
 
+        try {
             var tier = repositories.findTier(name);
             if (tier == null) {
                 return ResponseEntity.notFound().build();
@@ -211,9 +223,9 @@ public ResponseEntity<CustomerListJson> getCustomersForTier(@PathVariable String
             produces = MediaType.APPLICATION_JSON_VALUE
     )
     public ResponseEntity<CustomerListJson> getCustomers() {
-        try {
-            admins.checkAdminUser();
+        admins.checkAdminUser();
 
+        try {
             var customers = repositories.findAllCustomers();
             var result = new CustomerListJson(customers.stream().map(Customer::toJson).toList());
             return ResponseEntity.ok(result);
@@ -237,6 +249,8 @@ public ResponseEntity<CustomerJson> getCustomer(@PathVariable String name) {
             }
 
             return ResponseEntity.ok(customer.toJson());
+        } catch (ErrorResultException exc) {
+            return exc.toResponseEntity(CustomerJson.class);
         } catch (Exception exc) {
             logger.error("failed retrieving customer {}", name, exc);
             return ResponseEntity.internalServerError().build();
@@ -280,6 +294,8 @@ public ResponseEntity<CustomerJson> createCustomer(@RequestBody CustomerJson cus
             }
 
             return ResponseEntity.ok(result);
+        } catch (ErrorResultException exc) {
+            return exc.toResponseEntity(CustomerJson.class);
         } catch (Exception exc) {
             logger.error("failed creating customer {}", customerJson.getName(), exc);
             return ResponseEntity.internalServerError().build();
@@ -321,6 +337,8 @@ public ResponseEntity<CustomerJson> updateCustomer(@PathVariable String name, @R
             }
 
             return ResponseEntity.ok(result);
+        } catch (ErrorResultException exc) {
+            return exc.toResponseEntity(CustomerJson.class);
         } catch (Exception exc) {
             logger.error("failed updating tier {}", name, exc);
             return ResponseEntity.internalServerError().build();
@@ -344,6 +362,8 @@ public ResponseEntity<CustomerMembershipListJson> getCustomerMembers(@PathVariab
             var membershipList = new CustomerMembershipListJson();
             membershipList.setCustomerMemberships(memberships.stream().map(CustomerMembership::toJson).toList());
             return ResponseEntity.ok(membershipList);
+        } catch (ErrorResultException exc) {
+            return exc.toResponseEntity(CustomerMembershipListJson.class);
         } catch (Exception exc) {
             logger.error("failed retrieving customer members {}", name, exc);
             return ResponseEntity.internalServerError().build();
@@ -419,6 +439,8 @@ public ResponseEntity<ResultJson> deleteCustomer(@PathVariable String name) {
             }
 
             return ResponseEntity.ok(result);
+        } catch (ErrorResultException exc) {
+            return exc.toResponseEntity();
         } catch (Exception exc) {
             logger.error("failed deleting customer {}", name, exc);
             return ResponseEntity.internalServerError().build();
@@ -430,9 +452,9 @@ public ResponseEntity<ResultJson> deleteCustomer(@PathVariable String name) {
             produces = MediaType.APPLICATION_JSON_VALUE
     )
     public ResponseEntity<UsageStatsListJson> getUsageStats(@PathVariable String name, @RequestParam(required = false) String date) {
-        try {
-            admins.checkAdminUser();
+        admins.checkAdminUser();
 
+        try {
             var customer = repositories.findCustomer(name);
             if (customer == null) {
                 return ResponseEntity.notFound().build();
@@ -447,4 +469,83 @@ public ResponseEntity<UsageStatsListJson> getUsageStats(@PathVariable String nam
             return ResponseEntity.internalServerError().build();
         }
     }
+
+    @GetMapping(
+            path = "/customers/{name}/tokens",
+            produces = MediaType.APPLICATION_JSON_VALUE
+    )
+    public ResponseEntity<List<RateLimitTokenJson>> getRateLimitTokens(@PathVariable String name) {
+        admins.checkAdminUser();
+
+        try {
+            var customer = repositories.findCustomer(name);
+            if (customer == null) {
+                return ResponseEntity.notFound().build();
+            }
+
+            repositories.findActiveRateLimitTokens(customer);
+            var tokens = repositories.findActiveRateLimitTokens(customer)
+                    .map(RateLimitToken::toJson)
+                    .toList();
+
+            return ResponseEntity.ok(tokens);
+        } catch (Exception exc) {
+            logger.error("failed retrieving rate limit tokens", exc);
+            return ResponseEntity.internalServerError().build();
+        }
+    }
+
+    @PostMapping(
+            path = "/customers/{name}/tokens",
+            produces = MediaType.APPLICATION_JSON_VALUE
+    )
+    public ResponseEntity<RateLimitTokenJson> createRateLimitToken(
+            @PathVariable String name,
+            @RequestParam(required = false) String description
+    ) {
+        try {
+            admins.checkAdminUser();
+
+            if (description != null && description.length() > TOKEN_DESCRIPTION_SIZE) {
+                var json = RateLimitTokenJson.error("The description must not be longer than " + TOKEN_DESCRIPTION_SIZE + " characters.");
+                return new ResponseEntity<>(json, HttpStatus.BAD_REQUEST);
+            }
+
+            var customer = repositories.findCustomer(name);
+            if (customer == null) {
+                return ResponseEntity.notFound().build();
+            }
+
+            return new ResponseEntity<>(customerService.createRateLimitToken(customer, description), HttpStatus.CREATED);
+        } catch (ErrorResultException exc) {
+            return exc.toResponseEntity(RateLimitTokenJson.class);
+        } catch (Exception exc) {
+            logger.error("failed creating rate limit token", exc);
+            return ResponseEntity.internalServerError().build();
+        }
+    }
+
+    @DeleteMapping(
+            path = "/customers/{name}/tokens/{id}",
+            produces = MediaType.APPLICATION_JSON_VALUE
+    )
+    public ResponseEntity<ResultJson> deactivateRateLimitToken(@PathVariable String name, @PathVariable long id) {
+        try {
+            admins.checkAdminUser();
+
+            var customer = repositories.findCustomer(name);
+            if (customer == null) {
+                return ResponseEntity.notFound().build();
+            }
+
+            return ResponseEntity.ok(customerService.deactivateRateLimitToken(customer, id));
+        } catch (ErrorResultException exc) {
+            return exc.toResponseEntity();
+        } catch (NotFoundException exc) {
+            return new ResponseEntity<>(ResultJson.error("Rate limit token does not exist."), HttpStatus.NOT_FOUND);
+        } catch (Exception exc) {
+            logger.error("failed deactivating rate limit token", exc);
+            return ResponseEntity.internalServerError().build();
+        }
+    }
 }

server/src/main/java/org/eclipse/openvsx/entities/RateLimitToken.java

@@ -0,0 +1,129 @@
+/******************************************************************************
+ * Copyright (c) 2026 Contributors to the Eclipse Foundation.
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * https://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *****************************************************************************/
+package org.eclipse.openvsx.entities;
+
+import jakarta.persistence.*;
+import org.eclipse.openvsx.json.RateLimitTokenJson;
+import org.eclipse.openvsx.util.TimeUtil;
+
+import java.io.Serial;
+import java.io.Serializable;
+import java.time.LocalDateTime;
+import java.util.Objects;
+
+@Entity
+@Table(name = "rate_limit_token")
+public class RateLimitToken implements Serializable {
+
+    @Serial
+    private static final long serialVersionUID = 1L;
+
+    @Id
+    @GeneratedValue(generator = "rateLimitTokenSeq")
+    @SequenceGenerator(name = "rateLimitTokenSeq", sequenceName = "rate_limit_token_seq", allocationSize = 1)
+    private long id;
+
+    @ManyToOne
+    @JoinColumn(name = "customer")
+    private Customer customer;
+
+    @Column(length = 64)
+    private String value;
+
+    private boolean active;
+
+    private LocalDateTime createdTimestamp;
+
+    @Column(length = 2048)
+    private String description;
+
+    /**
+     * Convert to a JSON object.
+     */
+    public RateLimitTokenJson toJson() {
+        var json = new RateLimitTokenJson();
+        json.setId(this.getId());
+        // The value is not included: it is displayed only when the token is created
+        if (this.getCreatedTimestamp() != null) {
+            json.setCreatedTimestamp(TimeUtil.toUTCString(this.getCreatedTimestamp()));
+        }
+        json.setDescription(this.getDescription());
+        return json;
+    }
+
+    public long getId() {
+        return id;
+    }
+
+    public void setId(long id) {
+		this.id = id;
+	}
+
+    public Customer getCustomer() {
+        return customer;
+    }
+
+    public void setCustomer(Customer customer) {
+        this.customer = customer;
+    }
+
+    public String getValue() {
+        return value;
+    }
+
+    public void setValue(String value) {
+        this.value = value;
+    }
+
+    public boolean isActive() {
+        return active;
+    }
+
+    public void setActive(boolean active) {
+        this.active = active;
+    }
+
+    public LocalDateTime getCreatedTimestamp() {
+        return createdTimestamp;
+    }
+
+    public void setCreatedTimestamp(LocalDateTime timestamp) {
+        this.createdTimestamp = timestamp;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public void setDescription(String description) {
+        this.description = description;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        RateLimitToken that = (RateLimitToken) o;
+        return id == that.id
+                && active == that.active
+                && Objects.equals(customer, that.customer)
+                && Objects.equals(value, that.value)
+                && Objects.equals(createdTimestamp, that.createdTimestamp)
+                && Objects.equals(description, that.description);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(id, customer, value, active, createdTimestamp, description);
+    }
+}