amogh-jahagirdar commented on code in PR #11577: URL: https://github.com/apache/iceberg/pull/11577#discussion_r1854001589
########## azure/src/main/java/org/apache/iceberg/azure/adlsv2/AzureSasCredentialRefresher.java: ########## @@ -0,0 +1,69 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ +package org.apache.iceberg.azure.adlsv2; + +import com.azure.core.credential.AzureSasCredential; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.TimeUnit; +import java.util.function.Supplier; +import org.apache.commons.lang3.tuple.Pair; + +public class AzureSasCredentialRefresher { + private final Supplier<Pair<String, Long>> sasTokenWithExpirationSupplier; + private final ScheduledExecutorService refreshExecutor; + + private final AzureSasCredential azureSasCredential; + + private static final long MAX_REFRESH_WINDOW_MILLIS = 300_000; // 5 minutes; + private static final long MIN_REFRESH_WAIT_MILLIS = 10; + + public AzureSasCredentialRefresher( + Supplier<Pair<String, Long>> sasTokenWithExpirationSupplier, + ScheduledExecutorService refreshExecutor) { + this.sasTokenWithExpirationSupplier = sasTokenWithExpirationSupplier; + this.refreshExecutor = refreshExecutor; + Pair<String, Long> sasTokenWithExpiration = sasTokenWithExpirationSupplier.get(); + this.azureSasCredential = new AzureSasCredential(sasTokenWithExpiration.getLeft()); + scheduleRefresh(System.currentTimeMillis(), sasTokenWithExpiration.getRight()); + } + + public AzureSasCredential get() { + return this.azureSasCredential; + } + + private void scheduleRefresh(long startTimeMillis, Long expireAtMillis) { + Review Comment: Unnecessary newline here ########## azure/src/main/java/org/apache/iceberg/azure/adlsv2/VendedAzureSasCredentialProvider.java: ########## @@ -0,0 +1,197 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ +package org.apache.iceberg.azure.adlsv2; + +import com.azure.core.credential.AzureSasCredential; +import java.io.Serializable; +import java.util.List; +import java.util.Map; +import java.util.concurrent.Future; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.TimeUnit; +import java.util.stream.Collectors; +import org.apache.commons.io.IOUtils; +import org.apache.commons.lang3.tuple.Pair; +import org.apache.iceberg.azure.AzureProperties; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.Maps; +import org.apache.iceberg.rest.ErrorHandlers; +import org.apache.iceberg.rest.HTTPClient; +import org.apache.iceberg.rest.RESTClient; +import org.apache.iceberg.rest.RESTUtil; +import org.apache.iceberg.rest.auth.OAuth2Properties; +import org.apache.iceberg.rest.auth.OAuth2Util; +import org.apache.iceberg.rest.credentials.Credential; +import org.apache.iceberg.rest.responses.LoadCredentialsResponse; +import org.apache.iceberg.util.SerializableMap; +import org.apache.iceberg.util.ThreadPools; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class VendedAzureSasCredentialProvider implements Serializable, AutoCloseable { + private static final Logger LOG = LoggerFactory.getLogger(VendedAzureSasCredentialProvider.class); + + private final SerializableMap<String, String> properties; + private transient volatile Map<String, AzureSasCredentialRefresher> + azureSasCredentialRefresherMap; + private transient volatile RESTClient client; + private transient volatile ScheduledExecutorService refreshExecutor; + + public static final String URI = "credentials.uri"; + private static final String THREAD_PREFIX = "adls-fileio-credential-refresh"; + + public VendedAzureSasCredentialProvider(Map<String, String> properties) { + Preconditions.checkArgument(null != properties, "Invalid properties: null"); + Preconditions.checkArgument(null != properties.get(URI), "Invalid URI: null"); + this.properties = SerializableMap.copyOf(properties); + azureSasCredentialRefresherMap = Maps.newHashMap(); + } + + public AzureSasCredential getCredential(String storageAccount) { Review Comment: In Iceberg we tend to not use `get` prefix since it doesn't really indicate much, could we just call this `credentialForAccount`? ########## azure/src/main/java/org/apache/iceberg/azure/adlsv2/AzureSasCredentialRefresher.java: ########## @@ -0,0 +1,69 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ +package org.apache.iceberg.azure.adlsv2; + +import com.azure.core.credential.AzureSasCredential; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.TimeUnit; +import java.util.function.Supplier; +import org.apache.commons.lang3.tuple.Pair; + +public class AzureSasCredentialRefresher { + private final Supplier<Pair<String, Long>> sasTokenWithExpirationSupplier; + private final ScheduledExecutorService refreshExecutor; + + private final AzureSasCredential azureSasCredential; + + private static final long MAX_REFRESH_WINDOW_MILLIS = 300_000; // 5 minutes; + private static final long MIN_REFRESH_WAIT_MILLIS = 10; + + public AzureSasCredentialRefresher( + Supplier<Pair<String, Long>> sasTokenWithExpirationSupplier, + ScheduledExecutorService refreshExecutor) { + this.sasTokenWithExpirationSupplier = sasTokenWithExpirationSupplier; + this.refreshExecutor = refreshExecutor; + Pair<String, Long> sasTokenWithExpiration = sasTokenWithExpirationSupplier.get(); + this.azureSasCredential = new AzureSasCredential(sasTokenWithExpiration.getLeft()); + scheduleRefresh(System.currentTimeMillis(), sasTokenWithExpiration.getRight()); + } + + public AzureSasCredential get() { + return this.azureSasCredential; + } + + private void scheduleRefresh(long startTimeMillis, Long expireAtMillis) { + + long expireInMillis = expireAtMillis - startTimeMillis; + long refreshWindowMillis = Math.min(expireInMillis / 10, MAX_REFRESH_WINDOW_MILLIS); + long waitIntervalMillis = expireInMillis - refreshWindowMillis; + long elapsedMillis = System.currentTimeMillis() - startTimeMillis; + long timeToWait = Math.max(waitIntervalMillis - elapsedMillis, MIN_REFRESH_WAIT_MILLIS); + this.refreshExecutor.schedule( + () -> { + long refreshStartTime = System.currentTimeMillis(); + Pair<String, Long> sasTokenWithExpiration = sasTokenWithExpirationSupplier.get(); + azureSasCredential.update(sasTokenWithExpiration.getLeft()); + if (sasTokenWithExpiration.getRight() != null) { + this.scheduleRefresh(refreshStartTime, sasTokenWithExpiration.getRight()); + } + }, + timeToWait, + TimeUnit.MILLISECONDS); Review Comment: I follow the logic but it feels a bit complex, and I'm not sure about recursively scheduling in this manner...I feel like having a separate `refreshDelay()` or something just for getting the `timeToWait` would make this easier to read. I'll try and implement a concrete example ########## azure/src/main/java/org/apache/iceberg/azure/adlsv2/AzureSasCredentialRefresher.java: ########## @@ -0,0 +1,69 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ +package org.apache.iceberg.azure.adlsv2; + +import com.azure.core.credential.AzureSasCredential; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.TimeUnit; +import java.util.function.Supplier; +import org.apache.commons.lang3.tuple.Pair; + +public class AzureSasCredentialRefresher { + private final Supplier<Pair<String, Long>> sasTokenWithExpirationSupplier; + private final ScheduledExecutorService refreshExecutor; + + private final AzureSasCredential azureSasCredential; Review Comment: Nit: We can group the private variables together, separated by a newline and then the static variables. ########## azure/src/main/java/org/apache/iceberg/azure/adlsv2/VendedAzureSasCredentialProvider.java: ########## @@ -0,0 +1,197 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ +package org.apache.iceberg.azure.adlsv2; + +import com.azure.core.credential.AzureSasCredential; +import java.io.Serializable; +import java.util.List; +import java.util.Map; +import java.util.concurrent.Future; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.TimeUnit; +import java.util.stream.Collectors; +import org.apache.commons.io.IOUtils; +import org.apache.commons.lang3.tuple.Pair; +import org.apache.iceberg.azure.AzureProperties; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.Maps; +import org.apache.iceberg.rest.ErrorHandlers; +import org.apache.iceberg.rest.HTTPClient; +import org.apache.iceberg.rest.RESTClient; +import org.apache.iceberg.rest.RESTUtil; +import org.apache.iceberg.rest.auth.OAuth2Properties; +import org.apache.iceberg.rest.auth.OAuth2Util; +import org.apache.iceberg.rest.credentials.Credential; +import org.apache.iceberg.rest.responses.LoadCredentialsResponse; +import org.apache.iceberg.util.SerializableMap; +import org.apache.iceberg.util.ThreadPools; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class VendedAzureSasCredentialProvider implements Serializable, AutoCloseable { + private static final Logger LOG = LoggerFactory.getLogger(VendedAzureSasCredentialProvider.class); + + private final SerializableMap<String, String> properties; + private transient volatile Map<String, AzureSasCredentialRefresher> + azureSasCredentialRefresherMap; + private transient volatile RESTClient client; + private transient volatile ScheduledExecutorService refreshExecutor; + + public static final String URI = "credentials.uri"; + private static final String THREAD_PREFIX = "adls-fileio-credential-refresh"; + + public VendedAzureSasCredentialProvider(Map<String, String> properties) { + Preconditions.checkArgument(null != properties, "Invalid properties: null"); + Preconditions.checkArgument(null != properties.get(URI), "Invalid URI: null"); + this.properties = SerializableMap.copyOf(properties); + azureSasCredentialRefresherMap = Maps.newHashMap(); + } + + public AzureSasCredential getCredential(String storageAccount) { + Map<String, AzureSasCredentialRefresher> refresherMap = azureSasCredentialRefresherMap(); + if (refresherMap.containsKey(storageAccount)) { + return refresherMap.get(storageAccount).get(); + } else { + AzureSasCredentialRefresher azureSasCredentialRefresher = + new AzureSasCredentialRefresher( + () -> this.getSasTokenWithExpiration(storageAccount), credentialRefreshExecutor()); + refresherMap.put(storageAccount, azureSasCredentialRefresher); + return azureSasCredentialRefresher.get(); + } + } + + private Pair<String, Long> getSasTokenWithExpiration(String storageAccount) { Review Comment: Same as above, `sasTokenWithExpiration`? ########## azure/src/main/java/org/apache/iceberg/azure/adlsv2/VendedAzureSasCredentialProvider.java: ########## @@ -0,0 +1,197 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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. + */ +package org.apache.iceberg.azure.adlsv2; + +import com.azure.core.credential.AzureSasCredential; +import java.io.Serializable; +import java.util.List; +import java.util.Map; +import java.util.concurrent.Future; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.TimeUnit; +import java.util.stream.Collectors; +import org.apache.commons.io.IOUtils; +import org.apache.commons.lang3.tuple.Pair; +import org.apache.iceberg.azure.AzureProperties; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.Maps; +import org.apache.iceberg.rest.ErrorHandlers; +import org.apache.iceberg.rest.HTTPClient; +import org.apache.iceberg.rest.RESTClient; +import org.apache.iceberg.rest.RESTUtil; +import org.apache.iceberg.rest.auth.OAuth2Properties; +import org.apache.iceberg.rest.auth.OAuth2Util; +import org.apache.iceberg.rest.credentials.Credential; +import org.apache.iceberg.rest.responses.LoadCredentialsResponse; +import org.apache.iceberg.util.SerializableMap; +import org.apache.iceberg.util.ThreadPools; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class VendedAzureSasCredentialProvider implements Serializable, AutoCloseable { + private static final Logger LOG = LoggerFactory.getLogger(VendedAzureSasCredentialProvider.class); + + private final SerializableMap<String, String> properties; + private transient volatile Map<String, AzureSasCredentialRefresher> + azureSasCredentialRefresherMap; + private transient volatile RESTClient client; + private transient volatile ScheduledExecutorService refreshExecutor; + + public static final String URI = "credentials.uri"; + private static final String THREAD_PREFIX = "adls-fileio-credential-refresh"; + + public VendedAzureSasCredentialProvider(Map<String, String> properties) { + Preconditions.checkArgument(null != properties, "Invalid properties: null"); + Preconditions.checkArgument(null != properties.get(URI), "Invalid URI: null"); + this.properties = SerializableMap.copyOf(properties); + azureSasCredentialRefresherMap = Maps.newHashMap(); + } + + public AzureSasCredential getCredential(String storageAccount) { + Map<String, AzureSasCredentialRefresher> refresherMap = azureSasCredentialRefresherMap(); + if (refresherMap.containsKey(storageAccount)) { + return refresherMap.get(storageAccount).get(); + } else { + AzureSasCredentialRefresher azureSasCredentialRefresher = + new AzureSasCredentialRefresher( + () -> this.getSasTokenWithExpiration(storageAccount), credentialRefreshExecutor()); + refresherMap.put(storageAccount, azureSasCredentialRefresher); + return azureSasCredentialRefresher.get(); + } + } + + private Pair<String, Long> getSasTokenWithExpiration(String storageAccount) { + LoadCredentialsResponse response = fetchCredentials(); + List<Credential> adlsCredentials = + response.credentials().stream() + .filter(c -> c.prefix().contains(storageAccount)) + .collect(Collectors.toList()); + Preconditions.checkState( + !adlsCredentials.isEmpty(), + String.format("Invalid ADLS Credentials for storage-account %s: empty", storageAccount)); + Preconditions.checkState( + adlsCredentials.size() == 1, + "Invalid ADLS Credentials: only one ADLS credential should exist per storage-account"); + + Credential adlsCredential = adlsCredentials.get(0); + checkCredential(adlsCredential, AzureProperties.ADLS_SAS_TOKEN_PREFIX + storageAccount); + checkCredential( + adlsCredential, AzureProperties.ADLS_SAS_TOKEN_EXPIRE_AT_MS_PREFIX + storageAccount); + + String updatedSasToken = + adlsCredential.config().get(AzureProperties.ADLS_SAS_TOKEN_PREFIX + storageAccount); + String tokenExpiresAtMillis = + adlsCredential + .config() + .get(AzureProperties.ADLS_SAS_TOKEN_EXPIRE_AT_MS_PREFIX + storageAccount); + + Long expiresAtMs = Long.parseLong(tokenExpiresAtMillis); Review Comment: I think you can just inline adlsCredential.config().get(...) inside the Long.parseLong instead of having separate variables. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
