You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2021/10/21 23:30:26 UTC
[GitHub] [beam] pabloem commented on a change in pull request #15714: [BEAM-13005] [Playground] Implement local cache for pipelines' states
pabloem commented on a change in pull request #15714:
URL: https://github.com/apache/beam/pull/15714#discussion_r734105577
##########
File path: playground/backend/internal/cache/cache.go
##########
@@ -0,0 +1,52 @@
+// 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 cache
+
+import (
+ "context"
+ "github.com/google/uuid"
+ "os"
+ "time"
+)
+
+type SubKey string
+
+const (
+ SubKey_Status SubKey = "STATUS"
+ SubKey_RunOutput SubKey = "RUN_OUTPUT"
+ SubKey_CompileOutput SubKey = "COMPILE_OUTPUT"
+)
+
+type Cache interface {
Review comment:
we are caching by pipeline ID, right? How/where/when do we calculate a pipeline ID? What does a cache hit / miss look like?
##########
File path: playground/backend/internal/cache/cache.go
##########
@@ -0,0 +1,52 @@
+// 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 cache
+
+import (
+ "context"
+ "github.com/google/uuid"
+ "os"
+ "time"
+)
+
+type SubKey string
+
+const (
+ SubKey_Status SubKey = "STATUS"
+ SubKey_RunOutput SubKey = "RUN_OUTPUT"
+ SubKey_CompileOutput SubKey = "COMPILE_OUTPUT"
+)
+
+type Cache interface {
+ // GetValue returns value from cache by pipelineId and subKey.
+ GetValue(ctx context.Context, pipelineId uuid.UUID, subKey SubKey) (interface{}, error)
+
+ // SetValue adds value to cache by pipelineId and subKey.
Review comment:
Is SetValue meant to automatically configure an expiration time? I see that in the local cache, SetValue sets an expiration time as well. Can you document what's the expectation from users of the caches?
##########
File path: playground/backend/internal/cache/local_cache.go
##########
@@ -0,0 +1,122 @@
+// 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 cache
+
+import (
+ "context"
+ "fmt"
+ "github.com/google/uuid"
+ "sync"
+ "time"
+)
+
+const cleanupInterval = 5 * time.Second
+
+type LocalCache struct {
+ sync.RWMutex
+ cleanupInterval time.Duration
+ items map[uuid.UUID]map[SubKey]interface{}
+ pipelinesExpiration map[uuid.UUID]time.Time
+}
+
+func newLocalCache(ctx context.Context) *LocalCache {
+ items := make(map[uuid.UUID]map[SubKey]interface{})
+ pipelinesExpiration := make(map[uuid.UUID]time.Time)
+ ls := &LocalCache{
+ cleanupInterval: cleanupInterval,
+ items: items,
+ pipelinesExpiration: pipelinesExpiration,
+ }
+
+ go ls.startGC()
+ return ls
+
+}
+
+func (lc *LocalCache) GetValue(ctx context.Context, pipelineId uuid.UUID, subKey SubKey) (interface{}, error) {
+ lc.RLock()
+ value, found := lc.items[pipelineId][subKey]
+ if !found {
+ lc.RUnlock()
+ return nil, fmt.Errorf("value with pipelineId: %s and subKey: %s not found", pipelineId, subKey)
+ }
+ expTime := lc.pipelinesExpiration[pipelineId]
+ lc.RUnlock()
+
+ if expTime.Before(time.Now()) {
+ lc.Lock()
+ delete(lc.items[pipelineId], subKey)
+ delete(lc.pipelinesExpiration, pipelineId)
+ lc.Unlock()
+ return nil, fmt.Errorf("value with pipelineId: %s and subKey: %s is expired", pipelineId, subKey)
+ }
+
+ return value, nil
+}
+
+func (lc *LocalCache) SetValue(ctx context.Context, pipelineId uuid.UUID, subKey SubKey, value interface{}) error {
+ lc.Lock()
+ defer lc.Unlock()
+
+ _, ok := lc.items[pipelineId]
+ if !ok {
+ lc.items[pipelineId] = make(map[SubKey]interface{})
+ lc.pipelinesExpiration[pipelineId] = time.Now().Add(time.Hour)
+ }
+ lc.items[pipelineId][subKey] = value
+ return nil
+}
+
+func (lc *LocalCache) SetExpTime(ctx context.Context, pipelineId uuid.UUID, expTime time.Duration) error {
Review comment:
What happens if a user does this?
```
local_cache = new local cache()
local_cache.SetExpTime(ctx, "pipelineA", 1second)
// Now wait one second
```
Would `clearItems` throw an error because it tries to delete the pipeline from `lc.items`, but it's not part of it?
--
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: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org